]> BookStack Code Mirror - bookstack/blob - app/Repos/EntityRepo.php
Update Ldap.php
[bookstack] / app / Repos / EntityRepo.php
1 <?php namespace BookStack\Repos;
2
3 use BookStack\Book;
4 use BookStack\Chapter;
5 use BookStack\Entity;
6 use BookStack\Page;
7 use BookStack\Services\PermissionService;
8 use BookStack\User;
9 use Illuminate\Support\Collection;
10 use Illuminate\Support\Facades\Log;
11
12 class EntityRepo
13 {
14
15     /**
16      * @var Book $book
17      */
18     public $book;
19
20     /**
21      * @var Chapter
22      */
23     public $chapter;
24
25     /**
26      * @var Page
27      */
28     public $page;
29
30     /**
31      * @var PermissionService
32      */
33     protected $permissionService;
34
35     /**
36      * Acceptable operators to be used in a query
37      * @var array
38      */
39     protected $queryOperators = ['<=', '>=', '=', '<', '>', 'like', '!='];
40
41     /**
42      * EntityService constructor.
43      */
44     public function __construct()
45     {
46         $this->book = app(Book::class);
47         $this->chapter = app(Chapter::class);
48         $this->page = app(Page::class);
49         $this->permissionService = app(PermissionService::class);
50     }
51
52     /**
53      * Get the latest books added to the system.
54      * @param int $count
55      * @param int $page
56      * @param bool $additionalQuery
57      * @return
58      */
59     public function getRecentlyCreatedBooks($count = 20, $page = 0, $additionalQuery = false)
60     {
61         $query = $this->permissionService->enforceBookRestrictions($this->book)
62             ->orderBy('created_at', 'desc');
63         if ($additionalQuery !== false && is_callable($additionalQuery)) {
64             $additionalQuery($query);
65         }
66         return $query->skip($page * $count)->take($count)->get();
67     }
68
69     /**
70      * Get the most recently updated books.
71      * @param $count
72      * @param int $page
73      * @return mixed
74      */
75     public function getRecentlyUpdatedBooks($count = 20, $page = 0)
76     {
77         return $this->permissionService->enforceBookRestrictions($this->book)
78             ->orderBy('updated_at', 'desc')->skip($page * $count)->take($count)->get();
79     }
80
81     /**
82      * Get the latest pages added to the system.
83      * @param int $count
84      * @param int $page
85      * @param bool $additionalQuery
86      * @return
87      */
88     public function getRecentlyCreatedPages($count = 20, $page = 0, $additionalQuery = false)
89     {
90         $query = $this->permissionService->enforcePageRestrictions($this->page)
91             ->orderBy('created_at', 'desc')->where('draft', '=', false);
92         if ($additionalQuery !== false && is_callable($additionalQuery)) {
93             $additionalQuery($query);
94         }
95         return $query->with('book')->skip($page * $count)->take($count)->get();
96     }
97
98     /**
99      * Get the latest chapters added to the system.
100      * @param int $count
101      * @param int $page
102      * @param bool $additionalQuery
103      * @return
104      */
105     public function getRecentlyCreatedChapters($count = 20, $page = 0, $additionalQuery = false)
106     {
107         $query = $this->permissionService->enforceChapterRestrictions($this->chapter)
108             ->orderBy('created_at', 'desc');
109         if ($additionalQuery !== false && is_callable($additionalQuery)) {
110             $additionalQuery($query);
111         }
112         return $query->skip($page * $count)->take($count)->get();
113     }
114
115     /**
116      * Get the most recently updated pages.
117      * @param $count
118      * @param int $page
119      * @return mixed
120      */
121     public function getRecentlyUpdatedPages($count = 20, $page = 0)
122     {
123         return $this->permissionService->enforcePageRestrictions($this->page)
124             ->where('draft', '=', false)
125             ->orderBy('updated_at', 'desc')->with('book')->skip($page * $count)->take($count)->get();
126     }
127
128     /**
129      * Get draft pages owned by the current user.
130      * @param int $count
131      * @param int $page
132      */
133     public function getUserDraftPages($count = 20, $page = 0)
134     {
135         return $this->page->where('draft', '=', true)
136             ->where('created_by', '=', user()->id)
137             ->orderBy('updated_at', 'desc')
138             ->skip($count * $page)->take($count)->get();
139     }
140
141     /**
142      * Updates entity restrictions from a request
143      * @param $request
144      * @param Entity $entity
145      */
146     public function updateEntityPermissionsFromRequest($request, Entity $entity)
147     {
148         $entity->restricted = $request->has('restricted') && $request->get('restricted') === 'true';
149         $entity->permissions()->delete();
150         if ($request->has('restrictions')) {
151             foreach ($request->get('restrictions') as $roleId => $restrictions) {
152                 foreach ($restrictions as $action => $value) {
153                     $entity->permissions()->create([
154                         'role_id' => $roleId,
155                         'action'  => strtolower($action)
156                     ]);
157                 }
158             }
159         }
160         $entity->save();
161         $this->permissionService->buildJointPermissionsForEntity($entity);
162     }
163
164     /**
165      * Prepare a string of search terms by turning
166      * it into an array of terms.
167      * Keeps quoted terms together.
168      * @param $termString
169      * @return array
170      */
171     public function prepareSearchTerms($termString)
172     {
173         $termString = $this->cleanSearchTermString($termString);
174         preg_match_all('/(".*?")/', $termString, $matches);
175         $terms = [];
176         if (count($matches[1]) > 0) {
177             foreach ($matches[1] as $match) {
178                 $terms[] = $match;
179             }
180             $termString = trim(preg_replace('/"(.*?)"/', '', $termString));
181         }
182         if (!empty($termString)) $terms = array_merge($terms, explode(' ', $termString));
183         return $terms;
184     }
185
186     /**
187      * Removes any special search notation that should not
188      * be used in a full-text search.
189      * @param $termString
190      * @return mixed
191      */
192     protected function cleanSearchTermString($termString)
193     {
194         // Strip tag searches
195         $termString = preg_replace('/\[.*?\]/', '', $termString);
196         // Reduced multiple spacing into single spacing
197         $termString = preg_replace("/\s{2,}/", " ", $termString);
198         return $termString;
199     }
200
201     /**
202      * Get the available query operators as a regex escaped list.
203      * @return mixed
204      */
205     protected function getRegexEscapedOperators()
206     {
207         $escapedOperators = [];
208         foreach ($this->queryOperators as $operator) {
209             $escapedOperators[] = preg_quote($operator);
210         }
211         return join('|', $escapedOperators);
212     }
213
214     /**
215      * Parses advanced search notations and adds them to the db query.
216      * @param $query
217      * @param $termString
218      * @return mixed
219      */
220     protected function addAdvancedSearchQueries($query, $termString)
221     {
222         $escapedOperators = $this->getRegexEscapedOperators();
223         // Look for tag searches
224         preg_match_all("/\[(.*?)((${escapedOperators})(.*?))?\]/", $termString, $tags);
225         if (count($tags[0]) > 0) {
226             $this->applyTagSearches($query, $tags);
227         }
228
229         return $query;
230     }
231
232     /**
233      * Apply extracted tag search terms onto a entity query.
234      * @param $query
235      * @param $tags
236      * @return mixed
237      */
238     protected function applyTagSearches($query, $tags) {
239         $query->where(function($query) use ($tags) {
240             foreach ($tags[1] as $index => $tagName) {
241                 $query->whereHas('tags', function($query) use ($tags, $index, $tagName) {
242                     $tagOperator = $tags[3][$index];
243                     $tagValue = $tags[4][$index];
244                     if (!empty($tagOperator) && !empty($tagValue) && in_array($tagOperator, $this->queryOperators)) {
245                         if (is_numeric($tagValue) && $tagOperator !== 'like') {
246                             // We have to do a raw sql query for this since otherwise PDO will quote the value and MySQL will
247                             // search the value as a string which prevents being able to do number-based operations
248                             // on the tag values. We ensure it has a numeric value and then cast it just to be sure.
249                             $tagValue = (float) trim($query->getConnection()->getPdo()->quote($tagValue), "'");
250                             $query->where('name', '=', $tagName)->whereRaw("value ${tagOperator} ${tagValue}");
251                         } else {
252                             $query->where('name', '=', $tagName)->where('value', $tagOperator, $tagValue);
253                         }
254                     } else {
255                         $query->where('name', '=', $tagName);
256                     }
257                 });
258             }
259         });
260         return $query;
261     }
262
263     /**
264      * Alias method to update the book jointPermissions in the PermissionService.
265      * @param Collection $collection collection on entities
266      */
267     public function buildJointPermissions(Collection $collection)
268     {
269         $this->permissionService->buildJointPermissionsForEntities($collection);
270     }
271
272     /**
273      * Format a name as a url slug.
274      * @param $name
275      * @return string
276      */
277     protected function nameToSlug($name)
278     {
279         $slug = str_replace(' ', '-', strtolower($name));
280         $slug = preg_replace('/[\+\/\\\?\@\}\{\.\,\=\[\]\#\&\!\*\'\;\:\$\%]/', '', $slug);
281         if ($slug === "") $slug = substr(md5(rand(1, 500)), 0, 5);
282         return $slug;
283     }
284
285 }
286
287
288
289
290
291
292
293
294
295
296
297