337 lines
11 KiB
PHP
337 lines
11 KiB
PHP
<?php
|
||
namespace SilverStripe\Blog\Model;
|
||
|
||
use SilverStripe\Control\Controller;
|
||
use SilverStripe\Forms\FieldList;
|
||
use SilverStripe\Forms\Tab;
|
||
use SilverStripe\Forms\TabSet;
|
||
use SilverStripe\Forms\TextField;
|
||
use SilverStripe\ORM\DataList;
|
||
use SilverStripe\ORM\ValidationResult;
|
||
use SilverStripe\Security\Member;
|
||
use SilverStripe\Security\Permission;
|
||
use SilverStripe\View\Parsers\URLSegmentFilter;
|
||
|
||
/**
|
||
* An object shared by BlogTag and BlogCategory.
|
||
*
|
||
*/
|
||
trait BlogObject
|
||
{
|
||
private static $char_map = array(
|
||
// Latin
|
||
'À' => 'A', 'Á' => 'A', 'Â' => 'A', 'Ã' => 'A', 'Ä' => 'A', 'Å' => 'A', 'Æ' => 'AE', 'Ç' => 'C',
|
||
'È' => 'E', 'É' => 'E', 'Ê' => 'E', 'Ë' => 'E', 'Ì' => 'I', 'Í' => 'I', 'Î' => 'I', 'Ï' => 'I',
|
||
'Ð' => 'D', 'Ñ' => 'N', 'Ò' => 'O', 'Ó' => 'O', 'Ô' => 'O', 'Õ' => 'O', 'Ö' => 'O', 'Ő' => 'O',
|
||
'Ø' => 'O', 'Ù' => 'U', 'Ú' => 'U', 'Û' => 'U', 'Ü' => 'U', 'Ű' => 'U', 'Ý' => 'Y', 'Þ' => 'TH',
|
||
'ß' => 'ss',
|
||
'à' => 'a', 'á' => 'a', 'â' => 'a', 'ã' => 'a', 'ä' => 'a', 'å' => 'a', 'æ' => 'ae', 'ç' => 'c',
|
||
'è' => 'e', 'é' => 'e', 'ê' => 'e', 'ë' => 'e', 'ì' => 'i', 'í' => 'i', 'î' => 'i', 'ï' => 'i',
|
||
'ð' => 'd', 'ñ' => 'n', 'ò' => 'o', 'ó' => 'o', 'ô' => 'o', 'õ' => 'o', 'ö' => 'o', 'ő' => 'o',
|
||
'ø' => 'o', 'ù' => 'u', 'ú' => 'u', 'û' => 'u', 'ü' => 'u', 'ű' => 'u', 'ý' => 'y', 'þ' => 'th',
|
||
'ÿ' => 'y',
|
||
// Latin symbols
|
||
'©' => '(c)',
|
||
// Greek
|
||
'Α' => 'A', 'Β' => 'B', 'Γ' => 'G', 'Δ' => 'D', 'Ε' => 'E', 'Ζ' => 'Z', 'Η' => 'H', 'Θ' => '8',
|
||
'Ι' => 'I', 'Κ' => 'K', 'Λ' => 'L', 'Μ' => 'M', 'Ν' => 'N', 'Ξ' => '3', 'Ο' => 'O', 'Π' => 'P',
|
||
'Ρ' => 'R', 'Σ' => 'S', 'Τ' => 'T', 'Υ' => 'Y', 'Φ' => 'F', 'Χ' => 'X', 'Ψ' => 'PS', 'Ω' => 'W',
|
||
'Ά' => 'A', 'Έ' => 'E', 'Ί' => 'I', 'Ό' => 'O', 'Ύ' => 'Y', 'Ή' => 'H', 'Ώ' => 'W', 'Ϊ' => 'I',
|
||
'Ϋ' => 'Y',
|
||
'α' => 'a', 'β' => 'b', 'γ' => 'g', 'δ' => 'd', 'ε' => 'e', 'ζ' => 'z', 'η' => 'h', 'θ' => '8',
|
||
'ι' => 'i', 'κ' => 'k', 'λ' => 'l', 'μ' => 'm', 'ν' => 'n', 'ξ' => '3', 'ο' => 'o', 'π' => 'p',
|
||
'ρ' => 'r', 'σ' => 's', 'τ' => 't', 'υ' => 'y', 'φ' => 'f', 'χ' => 'x', 'ψ' => 'ps', 'ω' => 'w',
|
||
'ά' => 'a', 'έ' => 'e', 'ί' => 'i', 'ό' => 'o', 'ύ' => 'y', 'ή' => 'h', 'ώ' => 'w', 'ς' => 's',
|
||
'ϊ' => 'i', 'ΰ' => 'y', 'ϋ' => 'y', 'ΐ' => 'i',
|
||
// Turkish
|
||
'Ş' => 'S', 'İ' => 'I', 'Ç' => 'C', 'Ü' => 'U', 'Ö' => 'O', 'Ğ' => 'G',
|
||
'ş' => 's', 'ı' => 'i', 'ç' => 'c', 'ü' => 'u', 'ö' => 'o', 'ğ' => 'g',
|
||
// Russian
|
||
'А' => 'A', 'Б' => 'B', 'В' => 'V', 'Г' => 'G', 'Д' => 'D', 'Е' => 'E', 'Ё' => 'Yo', 'Ж' => 'Zh',
|
||
'З' => 'Z', 'И' => 'I', 'Й' => 'J', 'К' => 'K', 'Л' => 'L', 'М' => 'M', 'Н' => 'N', 'О' => 'O',
|
||
'П' => 'P', 'Р' => 'R', 'С' => 'S', 'Т' => 'T', 'У' => 'U', 'Ф' => 'F', 'Х' => 'H', 'Ц' => 'C',
|
||
'Ч' => 'Ch', 'Ш' => 'Sh', 'Щ' => 'Sh', 'Ъ' => '', 'Ы' => 'Y', 'Ь' => '', 'Э' => 'E', 'Ю' => 'Yu',
|
||
'Я' => 'Ya',
|
||
'а' => 'a', 'б' => 'b', 'в' => 'v', 'г' => 'g', 'д' => 'd', 'е' => 'e', 'ё' => 'yo', 'ж' => 'zh',
|
||
'з' => 'z', 'и' => 'i', 'й' => 'j', 'к' => 'k', 'л' => 'l', 'м' => 'm', 'н' => 'n', 'о' => 'o',
|
||
'п' => 'p', 'р' => 'r', 'с' => 's', 'т' => 't', 'у' => 'u', 'ф' => 'f', 'х' => 'h', 'ц' => 'c',
|
||
'ч' => 'ch', 'ш' => 'sh', 'щ' => 'sh', 'ъ' => '', 'ы' => 'y', 'ь' => '', 'э' => 'e', 'ю' => 'yu',
|
||
'я' => 'ya',
|
||
// Ukrainian
|
||
'Є' => 'Ye', 'І' => 'I', 'Ї' => 'Yi', 'Ґ' => 'G',
|
||
'є' => 'ye', 'і' => 'i', 'ї' => 'yi', 'ґ' => 'g',
|
||
// Czech
|
||
'Č' => 'C', 'Ď' => 'D', 'Ě' => 'E', 'Ň' => 'N', 'Ř' => 'R', 'Š' => 'S', 'Ť' => 'T', 'Ů' => 'U',
|
||
'Ž' => 'Z',
|
||
'č' => 'c', 'ď' => 'd', 'ě' => 'e', 'ň' => 'n', 'ř' => 'r', 'š' => 's', 'ť' => 't', 'ů' => 'u',
|
||
'ž' => 'z',
|
||
// Polish
|
||
'Ą' => 'A', 'Ć' => 'C', 'Ę' => 'e', 'Ł' => 'L', 'Ń' => 'N', 'Ó' => 'o', 'Ś' => 'S', 'Ź' => 'Z',
|
||
'Ż' => 'Z',
|
||
'ą' => 'a', 'ć' => 'c', 'ę' => 'e', 'ł' => 'l', 'ń' => 'n', 'ó' => 'o', 'ś' => 's', 'ź' => 'z',
|
||
'ż' => 'z',
|
||
// Latvian
|
||
'Ā' => 'A', 'Č' => 'C', 'Ē' => 'E', 'Ģ' => 'G', 'Ī' => 'i', 'Ķ' => 'k', 'Ļ' => 'L', 'Ņ' => 'N',
|
||
'Š' => 'S', 'Ū' => 'u', 'Ž' => 'Z',
|
||
'ā' => 'a', 'č' => 'c', 'ē' => 'e', 'ģ' => 'g', 'ī' => 'i', 'ķ' => 'k', 'ļ' => 'l', 'ņ' => 'n',
|
||
'š' => 's', 'ū' => 'u', 'ž' => 'z'
|
||
);
|
||
|
||
|
||
|
||
|
||
/**
|
||
* Simple Generate SEO-friendly URLs
|
||
* @param $text
|
||
* @return null|string
|
||
*/
|
||
public static function generateURL($text ){
|
||
$text = preg_replace('~[^\pL\d]+~u', '-', $text);
|
||
|
||
$text = str_replace(array_keys(self::$char_map), self::$char_map, $text);
|
||
|
||
$text = iconv('utf-8', 'us-ascii//TRANSLIT', $text);
|
||
|
||
$text = preg_replace('~[^-\w]+~', '', $text);
|
||
|
||
|
||
$text = trim($text, '-');
|
||
|
||
|
||
$text = preg_replace('~-+~', '-', $text);
|
||
|
||
$text = strtolower($text);
|
||
|
||
if (empty($text)) {
|
||
return 'n-a';
|
||
}
|
||
|
||
return $text;
|
||
}
|
||
/**
|
||
* @return DataList
|
||
*/
|
||
public function BlogPosts()
|
||
{
|
||
$blogPosts = parent::BlogPosts();
|
||
|
||
$this->extend('updateGetBlogPosts', $blogPosts);
|
||
|
||
return $blogPosts;
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
public function getCMSFields()
|
||
{
|
||
$fields = TabSet::create(
|
||
'Root',
|
||
Tab::create(
|
||
'Main',
|
||
TextField::create('Title', _t(__CLASS__ . '.Title', 'Title'))
|
||
)
|
||
);
|
||
|
||
$fields = FieldList::create($fields);
|
||
$this->extend('updateCMSFields', $fields);
|
||
|
||
return $fields;
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
* @return ValidationResult
|
||
*/
|
||
public function validate()
|
||
{
|
||
/** @var ValidationResult $validation */
|
||
$validation = parent::validate();
|
||
if (!$validation->isValid()) {
|
||
return $validation;
|
||
}
|
||
|
||
$blog = $this->Blog();
|
||
if (!$blog || !$blog->exists()) {
|
||
return $validation;
|
||
}
|
||
|
||
if ($this->getDuplicatesByField('Title')->count() > 0) {
|
||
$validation->addError($this->getDuplicateError(), self::DUPLICATE_EXCEPTION);
|
||
}
|
||
|
||
return $validation;
|
||
}
|
||
|
||
/**
|
||
* Returns a relative link to this category.
|
||
*
|
||
* @return string
|
||
*/
|
||
public function getLink()
|
||
{
|
||
return Controller::join_links(
|
||
$this->Blog()->Link(),
|
||
$this->getListUrlSegment(),
|
||
$this->URLSegment
|
||
);
|
||
}
|
||
|
||
/**
|
||
* Inherits from the parent blog or can be overwritten using a DataExtension.
|
||
*
|
||
* @param null|Member $member
|
||
*
|
||
* @return bool
|
||
*/
|
||
public function canView($member = null)
|
||
{
|
||
$extended = $this->extendedCan(__FUNCTION__, $member);
|
||
|
||
if ($extended !== null) {
|
||
return $extended;
|
||
}
|
||
|
||
return $this->Blog()->canView($member);
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
public function canCreate($member = null, $context = [])
|
||
{
|
||
$extended = $this->extendedCan(__FUNCTION__, $member);
|
||
|
||
if ($extended !== null) {
|
||
return $extended;
|
||
}
|
||
|
||
$permission = Blog::config()->grant_user_permission;
|
||
|
||
return Permission::checkMember($member, $permission);
|
||
}
|
||
|
||
/**
|
||
* Inherits from the parent blog or can be overwritten using a DataExtension.
|
||
*
|
||
* @param null|Member $member
|
||
*
|
||
* @return bool
|
||
*/
|
||
public function canDelete($member = null)
|
||
{
|
||
$extended = $this->extendedCan(__FUNCTION__, $member);
|
||
|
||
if ($extended !== null) {
|
||
return $extended;
|
||
}
|
||
|
||
return $this->Blog()->canDelete($member);
|
||
}
|
||
|
||
/**
|
||
* Inherits from the parent blog or can be overwritten using a DataExtension.
|
||
*
|
||
* @param null|Member $member
|
||
*
|
||
* @return bool
|
||
*/
|
||
public function canEdit($member = null)
|
||
{
|
||
$extended = $this->extendedCan(__FUNCTION__, $member);
|
||
|
||
if ($extended !== null) {
|
||
return $extended;
|
||
}
|
||
|
||
return $this->Blog()->canEdit($member);
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
protected function onBeforeWrite()
|
||
{
|
||
parent::onBeforeWrite();
|
||
if ($this->exists() || empty($this->URLSegment)) {
|
||
return $this->generateURLSegment();
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Generates a unique URLSegment from the title.
|
||
*
|
||
* @param int $increment
|
||
*
|
||
* @return string
|
||
*/
|
||
public function generateURLSegment($increment = 0)
|
||
{
|
||
$increment = (int) $increment;
|
||
$filter = URLSegmentFilter::create();
|
||
|
||
// Setting this to on. Because of the UI flow, it would be quite a lot of work
|
||
// to support turning this off. (ie. the add by title flow would not work).
|
||
// If this becomes a problem we can approach it then.
|
||
// @see https://github.com/silverstripe/silverstripe-blog/issues/376
|
||
$filter->setAllowMultibyte(true);
|
||
|
||
$this->URLSegment = self::generateURL($this->Title);
|
||
|
||
if ($increment > 0) {
|
||
$this->URLSegment .= '-' . $increment;
|
||
}
|
||
|
||
if ($this->getDuplicatesByField('URLSegment')->count() > 0) {
|
||
$this->generateURLSegment($increment + 1);
|
||
}
|
||
|
||
return $this->URLSegment;
|
||
}
|
||
|
||
/**
|
||
* Looks for objects o the same type and the same value by the given Field
|
||
*
|
||
* @param string $field E.g. URLSegment or Title
|
||
* @return DataList
|
||
*/
|
||
protected function getDuplicatesByField($field)
|
||
{
|
||
$duplicates = DataList::create(self::class)
|
||
->filter(
|
||
[
|
||
$field => $this->$field,
|
||
'BlogID' => (int) $this->BlogID
|
||
]
|
||
);
|
||
|
||
if ($this->ID) {
|
||
$duplicates = $duplicates->exclude('ID', $this->ID);
|
||
}
|
||
|
||
return $duplicates;
|
||
}
|
||
|
||
/**
|
||
* This returns the url segment for the listing page.
|
||
* eg. 'categories' in /my-blog/categories/category-url
|
||
*
|
||
* This is not editable at the moment, but a method is being used incase we want
|
||
* to make it editable in the future. We can use this method to provide logic
|
||
* without replacing multiple areas of the code base. We're also not being opinionated
|
||
* about how the segment should be obtained at the moment and allowing for the
|
||
* implementation to decide.
|
||
*
|
||
* @return string
|
||
*/
|
||
abstract protected function getListUrlSegment();
|
||
|
||
/**
|
||
* Returns an error message for this object when it tries to write a duplicate.
|
||
*
|
||
* @return string
|
||
*/
|
||
abstract protected function getDuplicateError();
|
||
}
|
||
|