1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 <?php
/**
* TfContentObject class file.
*
* @copyright Simon Wilkinson 2013+ (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package content
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Base class for content objects. Represents a single content object.
*
* There is only one 'archtype' of content object in Tuskfish; it uses a subset of standard
* Dublin Core metadata fields plus a few more that are common to most content objects. Why? If you
* look at most common content types - articles, photos, downloads etc. - you will see that for the
* most part they all use the same fields (title, teaser, description, etc).
*
* By using a single table for content objects with common field names our queries become very
* simple and much redundancy is avoided. Content subclasses that don't need particular properties
* unset() them in their constructor.
*
* @copyright Simon Wilkinson 2013+ (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package content
* @uses trait TfLanguage to obtain a list of available translations.
* @uses trait TfMagicMethods Prevents direct setting of properties / unlisted properties.
* @uses trait TfMimetypes Access a list of known / acceptable file mimetypes.
* @properties TfValidator $validator Instance of the Tuskfish data validator class.
* @properties int $id Auto-increment, set by database.
* @properties string $type Content object type eg. TfArticle etc. [ALPHA]
* @properties string $title The name of this content.
* @properties string $teaser A short (one paragraph) summary or abstract for this content. [HTML]
* @properties string $description The full article or description of the content. [HTML]
* @properties string $media An associated download/audio/video file. [FILEPATH OR URL]
* @properties string $format Mimetype
* @properties string $fileSize Specify in bytes.
* @properties string $creator Author.
* @properties string image An associated image file, eg. a screenshot a good way to handle it. [FILEPATH OR URL]
* @properties string $caption Caption of the image file.
* @properties string $date Date of publication expressed as a string.
* @properties int $parent A source work or collection of which this content is part.
* @properties string $language Future proofing.
* @properties int $rights Intellectual property rights scheme or license under which the work is distributed.
* @properties string $publisher The entity responsible for distributing this work.
* @properties array $tags Tag IDs associated with this object; not persistent (stored as taglinks in taglinks table).
* @properties int $online Toggle object on or offline.
* @properties int $submissionTime Timestamp representing submission time.
* @properties int $lastUpdated Timestamp representing last time this object was updated.
* @properties int $expiresOn Timestamp indicating the expiry date for this object.
* @properties int $counter Number of times this content was viewed or downloaded.
* @properties string $metaTitle Set a custom page title for this content.
* @properties string $metaDescription Set a custom page meta description for this content.
* @properties string $seo SEO-friendly string; it will be appended to the URL for this content.
* @properties string $handler Handler for this object (not persistent).
* @properties string $template The template that should be used to display this object (not persistent).
* @properties string $module The module that handles this content type (not persistent).
* @properties string $icon The vector icon that represents this object type (not persistent).
*/
class TfContentObject
{
use TfLanguage;
use TfMagicMethods;
use TfMimetypes;
protected $validator;
protected $id = '';
protected $type = '';
protected $title = '';
protected $teaser = '';
protected $description = '';
protected $media = '';
protected $format = '';
protected $fileSize = '';
protected $creator = '';
protected $image = '';
protected $caption = '';
protected $date = '';
protected $parent = '';
protected $language = '';
protected $rights = '';
protected $publisher = '';
protected $tags = '';
protected $online = '';
protected $submissionTime = '';
protected $lastUpdated = '';
protected $expiresOn = '';
protected $counter = '';
protected $metaTitle = '';
protected $metaDescription = '';
protected $seo = '';
protected $handler = '';
protected $template = '';
protected $module = '';
protected $icon = '';
/**
* Constructor.
*
* @param TfValidator $validator An instance of the Tuskfish data validator class.
*/
function __construct(TfValidator $validator)
{
if (is_a($validator, 'TfValidator')) {
$this->validator = $validator;
} else {
trigger_error(TFISH_ERROR_NOT_OBJECT, E_USER_ERROR);
}
$this->setId(0);
$this->setType(get_class($this));
$this->setHandler($this->type . 'Handler');
$this->setRights(1);
$this->setOnline(1);
$this->setCounter(0);
$this->setTags(array());
}
/**
* Converts a content object to an array suitable for insert/update calls to the database.
*
* Note that the returned array observes the PARENT object's getPropertyWhitelist() as a
* restriction on the setting of keys. This whitelist explicitly excludes the handler,
* template and module properties as these are part of the class definition and are not stored
* in the database. Calling the parent's property whitelist ensures that properties that are
* unset by child classes are zeroed (this is important when an object is changed to a
* different subclass, as the properties used may differ).
*
* @return array Array of object property/values.
*/
public function convertObjectToArray()
{
$keyValues = array();
foreach ($this as $key => $value) {
$keyValues[$key] = $value;
}
// Unset non-persistanet properties that are not stored in the content table.
unset(
$keyValues['tags'],
$keyValues['icon'],
$keyValues['handler'],
$keyValues['module'],
$keyValues['template']
);
return $keyValues;
}
/**
* Escapes object properties for output to browser.
*
* Use this method to retrieve object properties when you want to send them to the browser.
* They will be automatically escaped with htmlspecialchars() to mitigate cross-site scripting
* attacks.
*
* Note that the method excludes the teaser and description fields by default, which are
* returned unescaped; these are dedicated HTML fields that have been input-validated
* with the HTMLPurifier library, and so *should* be safe. However, when editing these fields
* it is necessary to escape them in order to prevent TinyMCE deleting them, as the '&' part of
* entity encoding also needs to be escaped when in a textarea for some highly annoying reason.
*
* @param string $property Name of property.
* @param bool $escapeHtml Whether to escape HTML fields (teaser, description).
* @return string|null Human readable value escaped for display or null if property does not
* exist.
*/
public function escapeForXss(string $property, bool $escapeHtml = false)
{
$cleanProperty = $this->validator->trimString($property);
// If property is not set return null.
if (!isset($this->$cleanProperty)) {
return null;
}
// Format all data for display and convert TFISH_LINK to URL.
$humanReadableData = (string) $this->makeDataHumanReadable($cleanProperty);
$htmlFields = array('teaser', 'description', 'icon');
// Output HTML for display: Do not escape as it has been input filtered with HTMLPurifier.
if (in_array($property, $htmlFields, true) && $escapeHtml === false) {
return $humanReadableData;
}
// Output for display in the TinyMCE editor (edit mode): HTML must be DOUBLE
// escaped to meet specification requirements.
if (in_array($property, $htmlFields, true) && $escapeHtml === true) {
return htmlspecialchars($humanReadableData, ENT_NOQUOTES, 'UTF-8',
true);
}
// All other cases: Escape data for display.
return htmlspecialchars($humanReadableData, ENT_NOQUOTES, 'UTF-8', false);
}
/**
* Resizes and caches an associated image and returns a URL to the cached copy.
*
* Allows arbitrary sized thumbnails to be produced from the object's image property. These are
* saved in the cache for future lookups. Image proportions are always preserved, so if both
* width and height are specified, the larger dimension will take precedence for resizing and
* the other will be ignored.
*
* Usually, you want to produce an image of a specific width or (less commonly) height to meet
* a template/presentation requirement.
*
* @param int $width Width of the cached image output.
* @param int $height Height of the cached image output.
* @return string $url URL to the cached image.
*/
public function getCachedImage(int $width = 0, int $height = 0)
{
// Validate parameters; and at least one must be set.
$cleanWidth = $this->validator->isInt($width, 1) ? (int) $width : 0;
$cleanHeight = $this->validator->isInt($height, 1) ? (int) $height : 0;
if (!$cleanWidth && !$cleanHeight) {
return false;
}
// Check if this object actually has an associated image, and that it is readable.
if (!$this->image || !is_readable(TFISH_IMAGE_PATH . $this->image)) {
return false;
}
// Check if a cached copy of the requested dimensions already exists in the cache and return
// URL. CONVENTION: Thumbnail name should follow the pattern:
// imageFileName . '-' . $width . 'x' . $height
$filename = pathinfo($this->image, PATHINFO_FILENAME);
$extension = '.' . pathinfo($this->image, PATHINFO_EXTENSION);
$cachedPath = TFISH_PUBLIC_CACHE_PATH . $filename . '-';
$cachedUrl = TFISH_CACHE_URL . $filename . '-';
$originalPath = TFISH_IMAGE_PATH . $filename . $extension;
if ($cleanWidth > $cleanHeight) {
$cachedPath .= $cleanWidth . 'w' . $extension;
$cachedUrl .= $cleanWidth . 'w' . $extension;
} else {
$cachedPath .= $cleanHeight . 'h' . $extension;
$cachedUrl .= $cleanHeight . 'h' . $extension;
}
// Security check - is the cachedPath actually pointing at the cache directory? Because
// if it isn't, then we don't want to cooperate by returning anything.
if (is_readable($cachedPath)) {
return $cachedUrl;
} else {
// Get the size. Note that:
// $properties['mime'] holds the mimetype, eg. 'image/jpeg'.
// $properties[0] = width, [1] = height, [2] = width = "x" height = "y" which is useful
// for outputting size attribute.
$properties = getimagesize($originalPath);
if (!$properties) {
return false;
}
/**
* Resizing image with GD installed.
*/
// In order to preserve proportions, need to calculate the size of the other dimension.
if ($cleanWidth > $cleanHeight) {
$destinationWidth = $cleanWidth;
$destinationHeight = (int) (($cleanWidth / $properties[0]) * $properties[1]);
} else {
$destinationWidth = (int) (($cleanHeight / $properties[1]) * $properties[0]);
$destinationHeight = $cleanHeight;
}
// Get a reference to a new image resource.
// Creates a blank (black) image RESOURCE of the specified size.
$thumbnail = imagecreatetruecolor($destinationWidth, $destinationHeight);
// Different image types require different handling. JPEG and PNG support optional
// quality parameter
// TODO: Create a preference.
$result = false;
switch ($properties['mime']) {
case "image/jpeg":
$original = imagecreatefromjpeg($originalPath);
imagecopyresampled($thumbnail, $original, 0, 0, 0, 0, $destinationWidth,
$destinationHeight, $properties[0], $properties[1]);
// Optional third quality argument 0-99, higher is better quality.
$result = imagejpeg($thumbnail, $cachedPath, 80);
break;
case "image/png":
case "image/gif":
if ($properties['mime'] === "image/gif") {
$original = imagecreatefromgif($originalPath);
} else {
$original = imagecreatefrompng($originalPath);
}
/**
* Handle transparency
*
* The following code block (only) is a derivative of
* the PHP_image_resize project by Nimrod007, which is a fork of the
* smart_resize_image project by Maxim Chernyak. The source code is available
* from the link below, and it is distributed under the following license terms:
*
* Copyright © 2008 Maxim Chernyak
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* https://github.com/Nimrod007/PHP_image_resize
*/
// Sets the transparent colour in the given image, using a colour identifier
// created with imagecolorallocate().
$transparency = imagecolortransparent($original);
$numberOfColours = imagecolorstotal($original);
if ($transparency >= 0 && $transparency < $numberOfColours) {
// Get the colours for an index.
$transparentColour = imagecolorsforindex($original, $transparency);
// Allocate a colour for an image. The first call to imagecolorallocate()
// fills the background colour in palette-based images created using
// imagecreate().
$transparency = imagecolorallocate($thumbnail, $transparentColour['red'],
$transparentColour['green'], $transparentColour['blue']);
// Flood fill with the given colour starting at the given coordinate
// (0,0 is top left).
imagefill($thumbnail, 0, 0, $transparency);
// Define a colour as transparent.
imagecolortransparent($thumbnail, $transparency);
}
// Bugfix from original: Changed next block to be an independent if, instead of
// an elseif linked to previous block. Otherwise PNG transparency doesn't work.
if ($properties['mime'] === "image/png") {
// Set the blending mode for an image.
imagealphablending($thumbnail, false);
// Allocate a colour for an image ($image, $red, $green, $blue, $alpha).
$colour = imagecolorallocatealpha($thumbnail, 0, 0, 0, 127);
// Flood fill again.
imagefill($thumbnail, 0, 0, $colour);
// Set the flag to save full alpha channel information (as opposed to single
// colour transparency) when saving png images.
imagesavealpha($thumbnail, true);
}
/**
* End code derived from PHP_image_resize project.
*/
// Copy and resize part of an image with resampling.
imagecopyresampled($thumbnail, $original, 0, 0, 0, 0, $destinationWidth,
$destinationHeight, $properties[0], $properties[1]);
// Output a useable png or gif from the image resource.
if ($properties['mime'] === "image/gif") {
$result = imagegif($thumbnail, $cachedPath);
} else {
// Quality is controlled through an optional third argument (0-9, lower is
// better).
$result = imagepng($thumbnail, $cachedPath, 0);
}
break;
// Anything else, no can do.
default:
return false;
}
if ($result) {
imagedestroy($thumbnail); // Free memory.
return $cachedUrl; // Return the URL to the cached file.
} else {
return false;
}
return $cachedUrl;
}
}
/**
* Returns an array of audio mimetypes that are permitted for content objects.
*
* Note that ogg audio files should use the .oga extension, although the legacy .ogg extension
* is still acceptable, although it must no longer be used for video files.
*
* @return array Array of permitted audio mimetypes in file extension => mimetype format.
*/
public function getListOfAllowedAudioMimetypes()
{
return array(
"mp3" => "audio/mpeg",
"oga" => "audio/ogg",
"ogg" => "audio/ogg",
"wav" => "audio/x-wav"
);
}
/**
* Returns an array of image mimetypes that are permitted for content objects.
*
* @return array Array of permitted image mimetypes in file extension => mimetype format.
*/
public function getListOfAllowedImageMimetypes()
{
return array(
"gif" => "image/gif",
"jpg" => "image/jpeg",
"png" => "image/png"
);
}
/**
* Returns an array of video mimetypes that are permitted for upload.
*
* Note that ogg video files must use the .ogv file extension. Please do not use .ogg for
* video files as this practice has been deprecated in favour of .ogv. While .ogg is still in
* wide use it is now presumed to refer to audio files only.
*
* @return array Array of permitted video mimetypes in file extension => mimetype format.
*/
public function getListOfAllowedVideoMimetypes()
{
return array(
"mp4" => "video/mp4",
"ogv" => "video/ogg",
"webm" => "video/webm"
);
}
/**
* Returns a list of intellectual property rights licenses for the content submission form.
*
* In the interests of brevity and sanity, a comprehensive list is not provided. Add entries
* that you want to use to the array below. Be aware that deleting entries that are in use by
* your content objects will cause errors.
*
* @return array Array of copyright licenses.
*/
public function getListOfRights()
{
return array(
'1' => TFISH_RIGHTS_COPYRIGHT,
'2' => TFISH_RIGHTS_ATTRIBUTION,
'3' => TFISH_RIGHTS_ATTRIBUTION_SHARE_ALIKE,
'4' => TFISH_RIGHTS_ATTRIBUTION_NO_DERIVS,
'5' => TFISH_RIGHTS_ATTRIBUTION_NON_COMMERCIAL,
'6' => TFISH_RIGHTS_ATTRIBUTION_NON_COMMERCIAL_SHARE_ALIKE,
'7' => TFISH_RIGHTS_ATTRIBUTION_NON_COMMERCIAL_NO_DERIVS,
'8' => TFISH_RIGHTS_GPL2,
'9' => TFISH_RIGHTS_GPL3,
'10' => TFISH_RIGHTS_PUBLIC_DOMAIN,
);
}
/**
* Returns an array of base object properties that are not used by this subclass.
*
* This list is also used in update calls to the database to ensure that unused columns are
* cleared and reset with default values.
*
* @return array
*/
public function getListOfZeroedProperties()
{
return array();
}
/**
* Returns a whitelist of object properties whose values are allowed be set.
*
* This function is used to build a list of $allowedVars for a content object. Child classes
* use this list to unset properties they do not use. Properties that are not resident in the
* database are also unset here (handler, template, module and icon).
*
* @return array Array of object properties as keys.
*/
public function getPropertyWhitelist()
{
$properties = array();
foreach ($this as $key => $value) {
$properties[$key] = '';
}
unset($properties['handler'], $properties['template'], $properties['module'],
$properties['icon']);
return $properties;
}
/**
* Generates a URL to access this object in single view mode.
*
* URL can point relative to either the home page (index.php, or other custom content stream
* page defined by modifying TFISH_PERMALINK_URL in config.php) or to an arbitrary page in the
* web root. For example, you could rename index.php to 'blog.php' to free up the index page
* for a landing page (this requires you to append the name of the new page to the
* TFISH_PERMALINK_URL constant).
*
* You can set up an articles.php page to display only TfArticle objects. The
* subclass-specific pages are found in the trust_path/extras folder. Just drop
* them into your site root to use them.
*
* @param string $customPage Use an arbitrary target page or the home page (index.php).
* @return string URL to view this object.
*/
public function getUrl(string $customPage = '')
{
$url = empty($customPage) ? TFISH_PERMALINK_URL : TFISH_URL;
if ($customPage) {
$url .= $this->validator->isAlnumUnderscore($customPage)
? $this->validator->trimString($customPage) . '.php' : '';
}
$url .= '?id=' . (int) $this->id;
if ($this->seo) {
$url .= '&title=' . $this->validator->encodeEscapeUrl($this->seo);
}
return $url;
}
/**
* Determine if the media file (mime) type is valid for this content type.
*
* Used in templates to determine whether a media file should be displayed or not.
* For example, if you attach a video file to an audio content object, the
* inline player will not be displayed (because it will not work).
*
* @return boolean True if media mimetype is valid for this content type, otherwise false.
*/
public function isValidMedia()
{
if (!$this->media) {
return false;
}
$allowedMimetypes = array();
switch($this->type) {
case "TfAudio":
$allowedMimetypes = $this->getListOfAllowedAudioMimetypes();
break;
case "TfImage":
$allowedMimetypes = $this->getListOfAllowedImageMimetypes();
break;
case "TfVideo":
$allowedMimetypes = $this->getListOfAllowedVideoMimetypes();
break;
default:
$allowedMimetypes = $this->getListOfPermittedUploadMimetypes();
}
if (in_array($this->format, $allowedMimetypes, true)) {
return true;
}
return false;
}
/**
* Populates the properties of the object from external (untrusted) data source.
*
* Note that the supplied data is internally validated by __set().
*
* @param array $dirtyInput Usually raw form $_REQUEST data.
* @param bool $liveUrls Convert base url to TFISH_LINK (true) or TFISH_LINK to base url (false).
*/
public function loadPropertiesFromArray(array $dirtyInput, $liveUrls = true)
{
$deleteImage = (isset($dirtyInput['deleteImage']) && !empty($dirtyInput['deleteImage']))
? true : false;
$deleteMedia = (isset($dirtyInput['deleteMedia']) && !empty($dirtyInput['deleteMedia']))
? true : false;
// Note that handler, template and module are not accessible through this method.
$propertyWhitelist = $this->getPropertyWhitelist();
foreach ($propertyWhitelist as $key => $type) {
if (array_key_exists($key, $dirtyInput)) {
$this->__set($key, $dirtyInput[$key]);
}
unset($key, $type);
}
if (array_key_exists('date', $propertyWhitelist) && empty($dirtyInput['date'])) {
$this->setDate(date(DATE_RSS, time()));
}
// Convert URLs back to TFISH_LINK for insertion or update, to aid portability.
if (array_key_exists('teaser', $propertyWhitelist) && !empty($dirtyInput['teaser'])) {
if ($liveUrls === true) {
$teaser = str_replace(TFISH_LINK, 'TFISH_LINK', $dirtyInput['teaser']);
} else {
$teaser = str_replace('TFISH_LINK', TFISH_LINK, $dirtyInput['teaser']);
}
$this->setTeaser($teaser);
}
if (array_key_exists('description', $propertyWhitelist)
&& !empty($dirtyInput['description'])) {
if ($liveUrls === true) {
$description = str_replace(TFISH_LINK, 'TFISH_LINK', $dirtyInput['description']);
} else {
$description = str_replace('TFISH_LINK', TFISH_LINK, $dirtyInput['description']);
}
$this->setDescription($description);
}
if (array_key_exists('image', $propertyWhitelist) && !empty($_FILES['image']['name'])) {
$cleanImageFilename = $this->validator->trimString($_FILES['image']['name']);
if ($cleanImageFilename) {
$this->setImage($cleanImageFilename);
}
}
if (array_key_exists('media', $propertyWhitelist) && !empty($_FILES['media']['name'])) {
$cleanMediaFilename = $this->validator->trimString($_FILES['media']['name']);
if ($cleanMediaFilename) {
$mimetypeWhitelist = $this->getListOfPermittedUploadMimetypes();
$extension = mb_strtolower(pathinfo($cleanMediaFilename, PATHINFO_EXTENSION), 'UTF-8');
$this->setMedia($cleanMediaFilename);
$this->setFormat($mimetypeWhitelist[$extension]);
$this->setFileSize($_FILES['media']['size']);
}
}
}
/**
* Converts properties to human readable form in preparation for output.
*
* This method is overridden in child subclasses, to allow for the possibility of handling
* additional properties. The overrides refer back to this parent method for handling base
* (standard) properties of this parent class.
*
* @param string $property Name of property.
* @return string Property formatted to human readable form for output.
*/
protected function makeDataHumanReadable(string $cleanProperty)
{
switch ($cleanProperty) {
case "date": // Stored in format yyyy-mm-dd
$date = new DateTime($this->$cleanProperty);
return $date->format('j F Y');
break;
case "fileSize": // Convert to human readable.
$bytes = (int) $this->$cleanProperty;
$unit = $val = '';
if ($bytes === 0 || $bytes < ONE_KILOBYTE) {
$unit = ' bytes';
$val = $bytes;
} elseif ($bytes >= ONE_KILOBYTE && $bytes < ONE_MEGABYTE) {
$unit = ' KB';
$val = ($bytes / ONE_KILOBYTE);
} elseif ($bytes >= ONE_MEGABYTE && $bytes < ONE_GIGABYTE) {
$unit = ' MB';
$val = ($bytes / ONE_MEGABYTE);
} else {
$unit = ' GB';
$val = ($bytes / ONE_GIGABYTE);
}
$val = round($val, 2);
return $val . ' ' . $unit;
break;
case "format": // Output the file extension as user-friendly "mimetype".
$mimetypeWhitelist = $this->getListOfPermittedUploadMimetypes();
$mimetype = array_search($this->$cleanProperty, $mimetypeWhitelist);
if (!empty($mimetype)) {
return $mimetype;
}
break;
case "description":
case "teaser":
// Do a simple string replace to allow TFISH_URL to be used as a constant,
// making the site portable.
$tfUrlEnabled = str_replace('TFISH_LINK', TFISH_LINK,
$this->$cleanProperty);
return $tfUrlEnabled;
break;
case "rights":
$rights = $this->getListOfRights();
return $rights[$this->$cleanProperty];
break;
case "submissionTime":
case "lastUpdated":
case "expiresOn":
$date = date('j F Y', $this->$cleanProperty);
return $date;
break;
case "tags":
$tags = array();
foreach ($this->$cleanProperty as $value) {
$tags[] = (int) $value;
unset($value);
}
return $tags;
break;
// No special handling required. Return unmodified value.
default:
return $this->$cleanProperty;
break;
}
}
/**
* Intercept direct setting of properties to permit data validation.
*
* It is best to set properties using the relevant setter method directly, as it is more
* efficient. However, due to use of PDO::FETCH_CLASS to automate instantiation of objects
* directly from the database, it is also necessary to allow them to be set via a magic method
* call.
*
* @param string $property Name of property.
* @param mixed $value Value of property.
*/
public function __set(string $property, $value)
{
$cleanProperty = $this->validator->trimString($property);
if (isset($this->$cleanProperty)) {
switch ($cleanProperty) {
case "id":
$this->setId((int) $value);
break;
case "type":
$this->setType((string) $value);
break;
case "title":
$this->setTitle((string) $value);
break;
case "teaser":
$this->setTeaser((string) $value);
break;
case "description":
$this->setDescription((string) $value);
break;
case "media":
$this->setMedia((string) $value);
break;
case "format":
$this->setFormat((string) $value);
break;
case "fileSize":
$this->setFileSize((int) $value);
break;
case "creator":
$this->setCreator((string) $value);
break;
case "image":
$this->setImage((string) $value);
break;
case "caption":
$this->setCaption((string) $value);
break;
case "date":
$this->setDate((string) $value);
break;
case "parent":
$this->setParent((int) $value);
break;
case "language":
$this->setLanguage((string) $value);
break;
case "rights":
$this->setRights((int) $value);
break;
case "publisher":
$this->setPublisher((string) $value);
break;
case "tags":
$this->setTags((array) $value);
break;
case "online":
$this->setOnline((int) $value);
break;
case "submissionTime":
$this->setSubmissionTime((int) $value);
break;
case "lastUpdated":
$this->setLastUpdated((int) $value);
break;
case "expiresOn":
$this->setExpiresOn((int) $value);
break;
case "counter":
$this->setCounter((int) $value);
break;
case "metaTitle":
$this->setMetaTitle((string) $value);
break;
case "metaDescription":
$this->setMetaDescription((string) $value);
break;
case "seo":
$this->setSeo((string) $value);
break;
case "handler":
$this->setHandler((string) $value);
break;
case "template":
$this->setTemplate((string) $value);
break;
case "module":
$this->setModule((string) $value);
break;
case "icon":
$this->setIcon((string) $value);
break;
}
} else {
// Not a permitted property, do not set.
}
}
/**
* Set the caption that will accompany the image property.
*
* @param string $caption Caption describing image.
*/
public function setCaption(string $caption)
{
$cleanCaption = (string) $this->validator->trimString($caption);
$this->caption = $cleanCaption;
}
/**
* Set the view/download counter for this object.
*
* @param int $counter Counter value.
*/
public function setCounter(int $counter)
{
if ($this->validator->isInt($counter, 0)) {
$this->counter = $counter;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the creator of this object.
*
* @param string $creator Name of the creator.
*/
public function setCreator(string $creator)
{
$cleanCreator = (string) $this->validator->trimString($creator);
$this->creator = $cleanCreator;
}
/**
* Set the publication date of this object expressed as a string.
*
* @param string $date Publication date.
*/
public function setDate(string $date)
{
$date = (string) $this->validator->trimString($date);
// Ensure format complies with DATE_RSS
$checkDate = date_parse_from_format('Y-m-d', $date);
if (!$checkDate || $checkDate['warning_count'] > 0
|| $checkDate['error_count'] > 0) {
// Bad date supplied, default to today.
$date = date(DATE_RSS, time());
trigger_error(TFISH_ERROR_BAD_DATE_DEFAULTING_TO_TODAY, E_USER_WARNING);
}
$this->date = $date;
}
/**
* Set the description of this object (HTML field).
*
* @param string $description Description in HTML.
*/
public function setDescription(string $description)
{
$description = (string) $this->validator->trimString($description);
$this->description = $this->validator->filterHtml($description);
}
/**
* Set the expirty time for this content object (timestamp).
*
* @param int $expiresOn Timestamp.
*/
public function setExpiresOn(int $expiresOn)
{
if ($this->validator->isInt($expiresOn, 0)) {
$this->expiresOn = $expiresOn;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the file size for the media attachment to this object.
*
* @param int $fileSize Filesize in bytes.
*/
public function setFileSize(int $fileSize)
{
if ($this->validator->isInt($fileSize, 0)) {
$this->fileSize = $fileSize;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the format (mimetype) for the media attachment to this object.
*
* Mimetypes must be official/correct as they are used in headers to initiate streaming of
* media files.
*
* @param string $format Mimetype.
*/
public function setFormat(string $format)
{
$format = (string) $this->validator->trimString($format);
$mimetypeWhitelist = $this->getListOfPermittedUploadMimetypes();
if (!empty($format) && !in_array($format, $mimetypeWhitelist, true)) {
trigger_error(TFISH_ERROR_ILLEGAL_MIMETYPE, E_USER_ERROR);
}
$this->format = $format;
}
/**
* Set the handler class for this content type.
*
* For most content subclasses this will be the general TfishContentHandler. However, some
* subclasses use their own handler subclass (eg. TfishTagHandler and TfishCollection handler).
*
* @param string $handler Handler name (alphabetical characters only).f
*/
public function setHandler(string $handler)
{
$cleanHandler = (string) $this->validator->trimString($handler);
if ($this->validator->isAlpha($cleanHandler)) {
$this->handler = $cleanHandler;
} else {
trigger_error(TFISH_ERROR_NOT_ALPHA, E_USER_ERROR);
}
}
/**
* Set the icon for this content object.
*
* This is a HTML field.
*
* @param string $icon Icon expressed as a FontAwesome tag, eg. '<i class="fas fa-file-alt"></i>'
*/
public function setIcon(string $icon)
{
$icon = (string) $this->validator->trimString($icon);
$this->icon = $this->validator->filterHtml($icon);
}
/**
* Set the ID for this object.
*
* @param int $id ID of this object.
*/
public function setId(int $id)
{
if ($this->validator->isInt($id, 0)) {
$this->id = $id;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the image for this content object.
*
* @param string $image Filename of the image.
*/
public function setImage(string $image)
{
$image = (string) $this->validator->trimString($image);
// Check image/media paths for directory traversals and null byte injection.
if ($this->validator->hasTraversalorNullByte($image)) {
trigger_error(TFISH_ERROR_TRAVERSAL_OR_NULL_BYTE, E_USER_ERROR);
exit; // Hard stop due to high probability of abuse.
}
// Check image file is a permitted mimetype.
$mimetypeWhitelist = $this->getListOfAllowedImageMimetypes();
$extension = mb_strtolower(pathinfo($image, PATHINFO_EXTENSION), 'UTF-8');
if (!empty($extension) && !array_key_exists($extension, $mimetypeWhitelist)) {
$this->image = '';
trigger_error(TFISH_ERROR_ILLEGAL_MIMETYPE, E_USER_ERROR);
} else {
$this->image = $image;
}
}
/**
* Set the language of this content object.
*
* @param string $language ISO_639-1 two-letter language code.
*/
public function setLanguage(string $language)
{
$language = (string) $this->validator->trimString($language);
$languageWhitelist = $this->getListOfLanguages();
if (!array_key_exists($language, $languageWhitelist)) {
trigger_error(TFISH_ERROR_ILLEGAL_VALUE, E_USER_ERROR);
}
$this->language = $language;
}
/**
* Set the last updated time for this content object (timestamp).
*
* @param int $lastUpdated Timestamp.
*/
public function setLastUpdated(int $lastUpdated)
{
if ($this->validator->isInt($lastUpdated, 0)) {
$this->lastUpdated = $lastUpdated;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the media attachment for this content object.
*
* @param string $media Filename of the media attachment.
*/
public function setMedia(string $media)
{
$media = (string) $this->validator->trimString($media);
// Check image/media paths for directory traversals and null byte injection.
if ($this->validator->hasTraversalorNullByte($media)) {
trigger_error(TFISH_ERROR_TRAVERSAL_OR_NULL_BYTE, E_USER_ERROR);
exit; // Hard stop due to high probability of abuse.
}
// Check media file is a permitted mimetype.
$mimetypeWhitelist = $this->getListOfPermittedUploadMimetypes();
$extension = mb_strtolower(pathinfo($media, PATHINFO_EXTENSION), 'UTF-8');
if (empty($extension)
|| (!empty($extension) && !array_key_exists($extension, $mimetypeWhitelist))) {
$this->media = '';
$this->format = '';
$this->fileSize = '';
} else {
$this->media = $media;
}
}
/**
* Set the meta description for this content object.
*
* @param string $metaDescription Meta description of this object.
*/
public function setMetaDescription(string $metaDescription)
{
$cleanMetaDescription = (string) $this->validator->trimString($metaDescription);
$this->metaDescription = $cleanMetaDescription;
}
/**
* Set the meta title for this object.
*
* @param string $metaTitle Meta title for this object.
*/
public function setMetaTitle(string $metaTitle)
{
$cleanMetaTitle = (string) $this->validator->trimString($metaTitle);
$this->metaTitle = $cleanMetaTitle;
}
/**
* Set the module for this content object.
*
* Usually handled by the object's constructor.
*
* @param string $module Module name.
*/
public function setModule(string $module)
{
$cleanModule = (string) $this->validator->trimString($module);
$this->module = $cleanModule;
}
/**
* Set this content object as online (1) or offline (0).
*
* Offline objects are not displayed on the front end or returned in search results.
*
* @param int $online Online (1) or offline (0).
*/
public function setOnline(int $online)
{
if ($this->validator->isInt($online, 0, 1)) {
$this->online = $online;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the ID of the parent for this object (must be a collection).
*
* Parent ID must be different to content ID (cannot declare self as parent).
*
* @param int $parent ID of parent object.
*/
public function setParent(int $parent)
{
if (!$this->validator->isInt($parent, 0)) {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
if ($parent === $this->id && $parent > 0) {
trigger_error(TFISH_ERROR_CIRCULAR_PARENT_REFERENCE);
} else {
$this->parent = $parent;
}
}
/**
* Set the publisher of this content object.
*
* @param string $publisher Name of the publisher.
*/
public function setPublisher(string $publisher)
{
$cleanPublisher = (string) $this->validator->trimString($publisher);
$this->publisher = $cleanPublisher;
}
/**
* Set the intellectual property rights for this content object.
*
* See getListOfRights() for the available licenses, which you can customise to suit yourself.
*
* @param int $rights ID of a copyright license.
*/
public function setRights(int $rights)
{
if ($this->validator->isInt($rights, 1)) {
$this->rights = $rights;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the SEO-friendly search string for this content object.
*
* The SEO string will be appended to the URL for this object.
*
* @param string $seo Dash-separated-title-of-this-object.
*/
public function setSeo(string $seo)
{
$cleanSeo = (string) $this->validator->trimString($seo);
// Replace spaces with dashes.
if ($this->validator->isUtf8($cleanSeo)) {
$cleanSeo = str_replace(' ', '-', $cleanSeo);
} else {
trigger_error(TFISH_ERROR_NOT_UTF8, E_USER_ERROR);
}
$this->seo = $cleanSeo;
}
/**
* Set the submission time for this content object (timestamp).
*
* @param int $submissionTime Timestamp.
*/
public function setSubmissionTime(int $submissionTime)
{
if ($this->validator->isInt($submissionTime, 1)) {
$this->submissionTime = $submissionTime;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Set the tags associated with this content object.
*
* @param array $tags IDs of associated tags.
*/
public function setTags(array $tags)
{
if ($this->validator->isArray($tags)) {
$cleanTags = array();
foreach ($tags as $tag) {
$cleanTag = (int) $tag;
if ($this->validator->isInt($cleanTag, 1)) {
$cleanTags[] = $cleanTag;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
unset($cleanTag);
}
$this->tags = $cleanTags;
} else {
trigger_error(TFISH_ERROR_NOT_ARRAY, E_USER_ERROR);
}
}
/**
* Set the teaser (short form description) for this content object.(HTML).
*
* @param string $teaser Teaser (in HTML).
*/
public function setTeaser(string $teaser)
{
$teaser = (string) $this->validator->trimString($teaser);
$this->teaser = $this->validator->filterHtml($teaser);
}
/**
* Set the template file for displaying this content object.
*
* The equivalent HTML template file must be present in the active theme.
*
* @param string $template Template filename without extension, eg. 'article'.
*/
public function setTemplate(string $template)
{
$cleanTemplate = (string) $this->validator->trimString($template);
if ($this->validator->isAlnumUnderscore($cleanTemplate)) {
$this->template = $cleanTemplate;
} else {
trigger_error(TFISH_ERROR_NOT_ALNUMUNDER, E_USER_ERROR);
}
}
/**
* Set the title of this content object.
*
* @param string $title Title of this object.
*/
public function setTitle(string $title)
{
$cleanTitle = (string) $this->validator->trimString($title);
$this->title = $cleanTitle;
}
/**
* Set the content type for this object.
*
* Type must be the name of a content subclass.
*
* @param string $type Class name for this content object.
*/
public function setType(string $type)
{
$cleanType = (string) $this->validator->trimString($type);
if ($this->validator->isAlpha($cleanType)) {
$this->type = $cleanType;
} else {
trigger_error(TFISH_ERROR_NOT_ALPHA, E_USER_ERROR);
}
}
/**
* Reset the last updated time for this content object (timestamp).
*/
public function updateLastUpdated()
{
$this->lastUpdated = time();
}
}