2016-02-27 19:24:42 +00:00
|
|
|
<?php namespace BookStack;
|
2015-08-16 13:51:45 +00:00
|
|
|
|
|
|
|
|
2016-05-07 13:29:43 +00:00
|
|
|
class Entity extends Ownable
|
2015-08-16 13:51:45 +00:00
|
|
|
{
|
2015-11-21 17:22:14 +00:00
|
|
|
|
2017-03-19 12:48:44 +00:00
|
|
|
protected $textField = 'description';
|
2017-01-01 16:57:47 +00:00
|
|
|
|
2015-08-16 13:51:45 +00:00
|
|
|
/**
|
|
|
|
* Compares this entity to another given entity.
|
|
|
|
* Matches by comparing class and id.
|
|
|
|
* @param $entity
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function matches($entity)
|
|
|
|
{
|
|
|
|
return [get_class($this), $this->id] === [get_class($entity), $entity->id];
|
|
|
|
}
|
2015-08-16 17:59:23 +00:00
|
|
|
|
2015-11-29 18:06:55 +00:00
|
|
|
/**
|
|
|
|
* Checks if an entity matches or contains another given entity.
|
|
|
|
* @param Entity $entity
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function matchesOrContains(Entity $entity)
|
|
|
|
{
|
|
|
|
$matches = [get_class($this), $this->id] === [get_class($entity), $entity->id];
|
|
|
|
|
|
|
|
if ($matches) return true;
|
|
|
|
|
2016-01-02 14:48:35 +00:00
|
|
|
if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
|
2015-11-29 18:06:55 +00:00
|
|
|
return $entity->book_id === $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($entity->isA('page') && $this->isA('chapter')) {
|
|
|
|
return $entity->chapter_id === $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-08-16 17:59:23 +00:00
|
|
|
/**
|
2015-11-21 17:22:14 +00:00
|
|
|
* Gets the activity objects for this entity.
|
2015-08-16 17:59:23 +00:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
|
|
|
public function activity()
|
|
|
|
{
|
2016-05-01 20:20:50 +00:00
|
|
|
return $this->morphMany(Activity::class, 'entity')->orderBy('created_at', 'desc');
|
2015-08-16 17:59:23 +00:00
|
|
|
}
|
|
|
|
|
2015-11-21 17:22:14 +00:00
|
|
|
/**
|
|
|
|
* Get View objects for this entity.
|
|
|
|
*/
|
|
|
|
public function views()
|
|
|
|
{
|
2016-05-01 20:20:50 +00:00
|
|
|
return $this->morphMany(View::class, 'viewable');
|
2015-11-21 17:22:14 +00:00
|
|
|
}
|
|
|
|
|
2016-05-06 19:33:08 +00:00
|
|
|
/**
|
2016-05-13 20:20:21 +00:00
|
|
|
* Get the Tag models that have been user assigned to this entity.
|
2016-05-06 19:33:08 +00:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
2016-05-13 20:20:21 +00:00
|
|
|
public function tags()
|
2016-05-06 19:33:08 +00:00
|
|
|
{
|
2016-05-14 19:02:00 +00:00
|
|
|
return $this->morphMany(Tag::class, 'entity')->orderBy('order', 'asc');
|
2016-05-06 19:33:08 +00:00
|
|
|
}
|
|
|
|
|
2017-03-19 12:48:44 +00:00
|
|
|
/**
|
|
|
|
* Get the related search terms.
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
|
|
|
public function searchTerms()
|
|
|
|
{
|
|
|
|
return $this->morphMany(SearchTerm::class, 'entity');
|
|
|
|
}
|
|
|
|
|
2015-08-31 10:43:28 +00:00
|
|
|
/**
|
2016-02-28 10:49:41 +00:00
|
|
|
* Get this entities restrictions.
|
|
|
|
*/
|
2016-05-01 20:20:50 +00:00
|
|
|
public function permissions()
|
2016-02-28 10:49:41 +00:00
|
|
|
{
|
2016-05-01 20:20:50 +00:00
|
|
|
return $this->morphMany(EntityPermission::class, 'restrictable');
|
2016-02-28 10:49:41 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if this entity has a specific restriction set against it.
|
|
|
|
* @param $role_id
|
|
|
|
* @param $action
|
2015-08-31 10:43:28 +00:00
|
|
|
* @return bool
|
|
|
|
*/
|
2016-02-28 10:49:41 +00:00
|
|
|
public function hasRestriction($role_id, $action)
|
2015-08-31 10:43:28 +00:00
|
|
|
{
|
2016-05-01 20:20:50 +00:00
|
|
|
return $this->permissions()->where('role_id', '=', $role_id)
|
2016-04-24 15:54:20 +00:00
|
|
|
->where('action', '=', $action)->count() > 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if this entity has live (active) restrictions in place.
|
|
|
|
* @param $role_id
|
|
|
|
* @param $action
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function hasActiveRestriction($role_id, $action)
|
|
|
|
{
|
2016-04-30 16:16:06 +00:00
|
|
|
return $this->getRawAttribute('restricted') && $this->hasRestriction($role_id, $action);
|
2015-08-31 10:43:28 +00:00
|
|
|
}
|
|
|
|
|
2016-04-23 17:14:26 +00:00
|
|
|
/**
|
2016-05-01 20:20:50 +00:00
|
|
|
* Get the entity jointPermissions this is connected to.
|
2016-04-23 17:14:26 +00:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
2016-05-01 20:20:50 +00:00
|
|
|
public function jointPermissions()
|
2016-04-23 17:14:26 +00:00
|
|
|
{
|
2016-05-01 20:20:50 +00:00
|
|
|
return $this->morphMany(JointPermission::class, 'entity');
|
2016-04-23 17:14:26 +00:00
|
|
|
}
|
|
|
|
|
2015-08-31 19:11:44 +00:00
|
|
|
/**
|
2015-08-31 10:43:28 +00:00
|
|
|
* Allows checking of the exact class, Used to check entity type.
|
|
|
|
* Cleaner method for is_a.
|
|
|
|
* @param $type
|
|
|
|
* @return bool
|
2015-08-31 19:11:44 +00:00
|
|
|
*/
|
2015-11-29 17:33:25 +00:00
|
|
|
public static function isA($type)
|
2015-08-31 10:43:28 +00:00
|
|
|
{
|
2016-04-23 17:14:26 +00:00
|
|
|
return static::getType() === strtolower($type);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get entity type.
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public static function getType()
|
|
|
|
{
|
|
|
|
return strtolower(static::getClassName());
|
2015-08-31 10:43:28 +00:00
|
|
|
}
|
|
|
|
|
2016-05-06 19:33:08 +00:00
|
|
|
/**
|
|
|
|
* Get an instance of an entity of the given type.
|
|
|
|
* @param $type
|
|
|
|
* @return Entity
|
|
|
|
*/
|
|
|
|
public static function getEntityInstance($type)
|
|
|
|
{
|
|
|
|
$types = ['Page', 'Book', 'Chapter'];
|
|
|
|
$className = str_replace([' ', '-', '_'], '', ucwords($type));
|
|
|
|
if (!in_array($className, $types)) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
return app('BookStack\\' . $className);
|
|
|
|
}
|
|
|
|
|
2015-12-05 14:41:51 +00:00
|
|
|
/**
|
2016-02-27 19:24:42 +00:00
|
|
|
* Gets a limited-length version of the entities name.
|
2015-12-05 14:41:51 +00:00
|
|
|
* @param int $length
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getShortName($length = 25)
|
|
|
|
{
|
2016-03-04 20:49:35 +00:00
|
|
|
if (strlen($this->name) <= $length) return $this->name;
|
|
|
|
return substr($this->name, 0, $length - 3) . '...';
|
2015-12-05 14:41:51 +00:00
|
|
|
}
|
|
|
|
|
2017-03-19 12:48:44 +00:00
|
|
|
/**
|
|
|
|
* Get the body text of this entity.
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function getText()
|
|
|
|
{
|
|
|
|
return $this->{$this->textField};
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return a generalised, common raw query that can be 'unioned' across entities.
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function entityRawQuery(){return '';}
|
|
|
|
|
2015-08-31 19:11:44 +00:00
|
|
|
/**
|
|
|
|
* Perform a full-text search on this entity.
|
|
|
|
* @param string[] $terms
|
2015-09-01 14:35:11 +00:00
|
|
|
* @param string[] array $wheres
|
2017-03-19 12:48:44 +00:00
|
|
|
* TODO - REMOVE
|
2015-08-31 19:11:44 +00:00
|
|
|
* @return mixed
|
|
|
|
*/
|
2017-01-01 16:57:47 +00:00
|
|
|
public function fullTextSearchQuery($terms, $wheres = [])
|
2015-08-31 19:11:44 +00:00
|
|
|
{
|
2016-03-04 20:49:35 +00:00
|
|
|
$exactTerms = [];
|
2016-09-29 08:13:15 +00:00
|
|
|
$fuzzyTerms = [];
|
|
|
|
$search = static::newQuery();
|
|
|
|
|
|
|
|
foreach ($terms as $key => $term) {
|
|
|
|
$term = htmlentities($term, ENT_QUOTES);
|
|
|
|
$term = preg_replace('/[+\-><\(\)~*\"@]+/', ' ', $term);
|
|
|
|
if (preg_match('/".*?"/', $term) || is_numeric($term)) {
|
|
|
|
$term = str_replace('"', '', $term);
|
|
|
|
$exactTerms[] = '%' . $term . '%';
|
|
|
|
} else {
|
|
|
|
$term = '' . $term . '*';
|
|
|
|
if ($term !== '*') $fuzzyTerms[] = $term;
|
2016-03-04 08:33:57 +00:00
|
|
|
}
|
2016-09-29 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2016-11-12 13:21:16 +00:00
|
|
|
$isFuzzy = count($exactTerms) === 0 && count($fuzzyTerms) > 0;
|
2017-03-19 12:48:44 +00:00
|
|
|
$fieldsToSearch = ['name', $this->textField];
|
2016-09-29 08:13:15 +00:00
|
|
|
|
|
|
|
// Perform fulltext search if relevant terms exist.
|
|
|
|
if ($isFuzzy) {
|
|
|
|
$termString = implode(' ', $fuzzyTerms);
|
2017-03-19 12:48:44 +00:00
|
|
|
|
2016-09-29 08:13:15 +00:00
|
|
|
$search = $search->selectRaw('*, MATCH(name) AGAINST(? IN BOOLEAN MODE) AS title_relevance', [$termString]);
|
2017-03-19 12:48:44 +00:00
|
|
|
$search = $search->whereRaw('MATCH(' . implode(',', $fieldsToSearch ). ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
|
2016-09-29 08:13:15 +00:00
|
|
|
}
|
2016-05-15 12:41:18 +00:00
|
|
|
|
2016-09-29 08:13:15 +00:00
|
|
|
// Ensure at least one exact term matches if in search
|
|
|
|
if (count($exactTerms) > 0) {
|
2017-03-19 12:48:44 +00:00
|
|
|
$search = $search->where(function ($query) use ($exactTerms, $fieldsToSearch) {
|
2016-09-29 08:13:15 +00:00
|
|
|
foreach ($exactTerms as $exactTerm) {
|
2017-03-19 12:48:44 +00:00
|
|
|
foreach ($fieldsToSearch as $field) {
|
2016-09-29 08:13:15 +00:00
|
|
|
$query->orWhere($field, 'like', $exactTerm);
|
2016-03-04 20:49:35 +00:00
|
|
|
}
|
2016-09-29 08:13:15 +00:00
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
$orderBy = $isFuzzy ? 'title_relevance' : 'updated_at';
|
2016-03-04 20:49:35 +00:00
|
|
|
|
2015-12-05 15:11:48 +00:00
|
|
|
// Add additional where terms
|
2015-09-01 14:35:11 +00:00
|
|
|
foreach ($wheres as $whereTerm) {
|
|
|
|
$search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]);
|
|
|
|
}
|
2016-09-29 08:13:15 +00:00
|
|
|
|
2015-12-05 15:11:48 +00:00
|
|
|
// Load in relations
|
2016-05-15 12:41:18 +00:00
|
|
|
if ($this->isA('page')) {
|
2016-02-21 12:53:58 +00:00
|
|
|
$search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');
|
2016-05-15 12:41:18 +00:00
|
|
|
} else if ($this->isA('chapter')) {
|
2016-02-21 12:53:58 +00:00
|
|
|
$search = $search->with('book');
|
|
|
|
}
|
2015-11-29 17:33:25 +00:00
|
|
|
|
2016-05-15 12:41:18 +00:00
|
|
|
return $search->orderBy($orderBy, 'desc');
|
2015-08-31 19:11:44 +00:00
|
|
|
}
|
2016-08-25 16:17:26 +00:00
|
|
|
|
2015-08-16 13:51:45 +00:00
|
|
|
}
|