1: <?php
  2: 
  3: /**
  4:  * zenpage news category class
  5:  *
  6:  * @author Malte Müller (acrylian)
  7:  * @package plugins
  8:  * @subpackage zenpage
  9:  */
 10: class ZenpageCategory extends ZenpageRoot {
 11: 
 12:     var $manage_rights = MANAGE_ALL_NEWS_RIGHTS;
 13:     var $manage_some_rights = ZENPAGE_NEWS_RIGHTS;
 14:     var $view_rights = ALL_NEWS_RIGHTS;
 15:     protected $sortorder = 'date';
 16:     protected $sortdirection = true;
 17:     protected $sortSticky = true;
 18: 
 19:     function __construct($catlink, $create = NULL) {
 20:         if (is_array($catlink)) {
 21:             $catlink = $catlink['titlelink'];
 22:         }
 23:         $new = $this->instantiate('news_categories', array('titlelink' => $catlink), 'titlelink', true, empty($catlink), $create);
 24:         $this->exists = $this->loaded;
 25:     }
 26: 
 27:     /**
 28:      * Returns the description
 29:      *
 30:      * @return string
 31:      */
 32:     function getDesc($locale = NULL) {
 33:         $text = $this->get('desc');
 34:         if ($locale == 'all') {
 35:             return zpFunctions::unTagURLs($text);
 36:         } else {
 37:             return applyMacros(zpFunctions::unTagURLs(get_language_string($text, $locale)));
 38:         }
 39:     }
 40: 
 41:     /**
 42:      * Stores the description
 43:      *
 44:      * @param string $desc description text
 45:      */
 46:     function setDesc($desc) {
 47:         $desc = zpFunctions::tagURLs($desc);
 48:         $this->set('desc', $desc);
 49:     }
 50: 
 51:     /**
 52:      * Returns the content
 53:      *
 54:      * @return string
 55:      */
 56:     function getContent($locale = NULL) {
 57:         $content = $this->get("content");
 58:         if ($locale == 'all') {
 59:             return zpFunctions::unTagURLs($content);
 60:         } else {
 61:             return applyMacros(zpFunctions::unTagURLs(get_language_string($content, $locale)));
 62:         }
 63:     }
 64: 
 65:     /**
 66:      *
 67:      * Set the content datum
 68:      * @param $c full language string
 69:      */
 70:     function setContent($c) {
 71:         $c = zpFunctions::tagURLs($c);
 72:         $this->set("content", $c);
 73:     }
 74: 
 75:     /**
 76:      * Returns the extra content
 77:      *
 78:      * @return string
 79:      */
 80:     function getExtraContent($locale = NULL) {
 81:         $text = $this->get("extracontent");
 82:         if ($locale == 'all') {
 83:             return zpFunctions::unTagURLs($text);
 84:         } else {
 85:             return applyMacros(zpFunctions::unTagURLs(get_language_string($text, $locale)));
 86:         }
 87:     }
 88: 
 89:     /**
 90:      * sets the extra content
 91:      *
 92:      */
 93:     function setExtraContent($ec) {
 94:         $this->set("extracontent", zpFunctions::tagURLs($ec));
 95:     }
 96: 
 97:     /**
 98:      * Returns the sort order
 99:      *
100:      * @return string
101:      */
102:     function getSortOrder() {
103:         return $this->get('sort_order');
104:     }
105: 
106:     /**
107:      * Stores the sort order
108:      *
109:      * @param string $sortorder image sort order
110:      */
111:     function setSortOrder($sortorder) {
112:         $this->set('sort_order', $sortorder);
113:     }
114: 
115:     function getSortDirection() {
116:         return $this->sortdirection;
117:     }
118: 
119:     function setSortDirection($value) {
120:         $this->sortdirection = (int) ($value && true);
121:     }
122: 
123:     function getSortType() {
124:         return $this->sortorder;
125:     }
126: 
127:     function setSortType($value) {
128:         $this->sortorder = $value;
129:     }
130: 
131:     function getSortSticky() {
132:         return $this->sortSticky;
133:     }
134: 
135:     function setSortSticky($value) {
136:         $this->sortSticky = (bool) $value;
137:     }
138: 
139:     function getUser() {
140:         return $this->get('user');
141:     }
142: 
143:     /**
144:      * Sets the guest user
145:      *
146:      * @param string $user
147:      */
148:     function setUser($user) {
149:         $this->set('user', $user);
150:     }
151: 
152:     function getPassword() {
153:         if (GALLERY_SECURITY != 'public') {
154:             return NULL;
155:         } else {
156:             return $this->get('password');
157:         }
158:     }
159: 
160:     /**
161:      * Sets the encrypted password
162:      *
163:      * @param string $pwd the cleartext password
164:      */
165:     function setPassword($pwd) {
166:         $this->set('password', $pwd);
167:     }
168: 
169:     function getPasswordHint() {
170:         return $this->get('password_hint');
171:     }
172: 
173:     /**
174:      * Sets the password hint
175:      *
176:      * @param string $hint the hint text
177:      */
178:     function setPasswordHint($hint) {
179:         $this->set('password_hint', $hint);
180:     }
181: 
182:     /**
183:      * Deletes a category (and also if existing its subpages) from the database
184:      *
185:      */
186:     function remove() {
187:         if ($success = parent::remove()) {
188:             $sortorder = $this->getSortOrder();
189:             $success = query("DELETE FROM " . prefix('news2cat') . " WHERE cat_id = " . $this->getID()); // the cat itself
190:             // get Subcategories
191:             $mychild = strlen($sortorder) + 4;
192:             $result = query_full_array('SELECT * FROM ' . prefix('news_categories') . " WHERE `sort_order` like '" . $sortorder . "-%'");
193:             if (is_array($result)) {
194:                 foreach ($result as $row) {
195:                     if (strlen($row['sort_order']) == $mychild) {
196:                         $subcat = new ZenpageCategory($row['titlelink']);
197:                         $success = $success && $subcat->remove();
198:                     }
199:                 }
200:             }
201:         }
202:         return $success;
203:     }
204: 
205:     /**
206:      * Gets the sub categories recursivly by titlelink
207:      * @param bool $visible TRUE for published and unprotected
208:      * @param string $sorttype NULL for the standard order as sorted on the backend, "title", "date", "popular"
209:      * @param string $sortdirection "asc" or "desc" for ascending or descending order
210:      * @return array
211:      */
212:     function getSubCategories($visible = true, $sorttype = NULL, $sortdirection = NULL) {
213:         global $_zp_zenpage;
214:         $subcategories = array();
215:         $sortorder = $this->getSortOrder();
216:         foreach ($_zp_zenpage->getAllCategories($visible, $sorttype, $sortdirection) as $cat) {
217:             $catobj = new ZenpageCategory($cat['titlelink']);
218:             if ($catobj->getParentID() == $this->getID() && $catobj->getSortOrder() != $sortorder) { // exclude the category itself!
219:                 array_push($subcategories, $catobj->getTitlelink());
220:             }
221:         }
222:         if (count($subcategories) != 0) {
223:             return $subcategories;
224:         }
225:         return FALSE;
226:     }
227: 
228:     /**
229:      * Checks if the current news category is a sub category of $catlink
230:      *
231:      * @return bool
232:      */
233:     function isSubNewsCategoryOf($catlink) {
234:         if (!empty($catlink)) {
235:             $parentid = $this->getParentID();
236:             $categories = $this->getParents();
237:             $count = 0;
238:             foreach ($categories as $cat) {
239:                 if ($catlink == $cat) {
240:                     $count = 1;
241:                     break;
242:                 }
243:             }
244:             return $count == 1;
245:         } else {
246:             return false;
247:         }
248:     }
249: 
250:     /**
251:      * Gets the parent categories recursivly to the category whose parentid is passed or the current object
252:      *
253:      * @param int $parentid The parentid of the category to get the parents of
254:      * @param bool $initparents
255:      * @return array
256:      */
257:     function getParents(&$parentid = '', $initparents = true) {
258:         global $parentcats, $_zp_zenpage;
259:         $allitems = $_zp_zenpage->getAllCategories(false);
260:         if ($initparents) {
261:             $parentcats = array();
262:         }
263:         if (empty($parentid)) {
264:             $currentparentid = $this->getParentID();
265:         } else {
266:             $currentparentid = $parentid;
267:         }
268:         foreach ($allitems as $item) {
269:             $obj = new ZenpageCategory($item['titlelink']);
270:             $itemtitlelink = $obj->getTitlelink();
271:             $itemid = $obj->getID();
272:             $itemparentid = $obj->getParentID();
273:             if ($itemid == $currentparentid) {
274:                 array_unshift($parentcats, $itemtitlelink);
275:                 $obj->getParents($itemparentid, false);
276:             }
277:         }
278:         return $parentcats;
279:     }
280: 
281:     /**
282:      * Checks if user is allowed to access news category
283:      * @param $hint
284:      * @param $show
285:      */
286:     function checkforGuest(&$hint = NULL, &$show = NULL) {
287:         if (!parent::checkForGuest()) {
288:             return false;
289:         }
290:         $obj = $this;
291:         $hash = $this->getPassword();
292:         while (empty($hash) && !is_null($obj)) {
293:             $parentID = $obj->getParentID();
294:             if (empty($parentID)) {
295:                 $obj = NULL;
296:             } else {
297:                 $sql = 'SELECT `titlelink` FROM ' . prefix('news_categories') . ' WHERE `id`=' . $parentID;
298:                 $result = query_single_row($sql);
299:                 $obj = new ZenpageCategory($result['titlelink']);
300:                 $hash = $obj->getPassword();
301:             }
302:         }
303:         if (empty($hash)) { // no password required
304:             return 'zp_public_access';
305:         } else {
306:             $authType = "zp_category_auth_" . $this->getID();
307:             $saved_auth = zp_getCookie($authType);
308:             if ($saved_auth == $hash) {
309:                 return $authType;
310:             } else {
311:                 $user = $this->getUser();
312:                 if (!empty($user))
313:                     $show = true;
314:                 $hint = $this->getPasswordHint();
315:                 return false;
316:             }
317:         }
318:     }
319: 
320:     /**
321:      * Checks if a category is protected and returns TRUE or FALSE
322:      *
323:      * @return bool
324:      */
325:     function isProtected() {
326:         return $this->checkforGuest() != 'zp_public_access';
327:     }
328: 
329:     function isMyItem($action) {
330:         global $_zp_current_admin_obj;
331:         if (parent::isMyItem($action)) {
332:             return true;
333:         }
334:         if (zp_loggedin($action)) {
335:             if ($action == LIST_RIGHTS && $this->getShow()) {
336:                 return true;
337:             }
338:             $mycategories = $_zp_current_admin_obj->getObjects('news');
339:             if (!empty($mycategories)) {
340:                 $allowed = $this->getParents();
341:                 array_unshift($allowed, $this->getTitlelink());
342:                 $overlap = array_intersect($mycategories, $allowed);
343:                 if (!empty($overlap)) {
344:                     return true;
345:                 }
346:             }
347:         }
348:         return false;
349:     }
350: 
351:     /**
352:      * Gets news articles titlelinks this category is attached to
353:      *
354:      * NOTE: Since this function only returns titlelinks for use with the object model it does not exclude articles that are password protected via a category
355:      *
356:      *
357:      * @param int $articles_per_page The number of articles to get
358:      * @param string $published "published" for published articles,
359:      *                                                  "published-unpublished" for published articles only from an unpublished category,
360:      *                                                  "unpublished" for unpublished articles,
361:      *                                                  "sticky" for sticky articles (published or not!) for Admin page use only,
362:      *                                                  "all" for all articles
363:      * @param boolean $ignorepagination Since also used for the news loop this function automatically paginates the results if the "page" GET variable is set. To avoid this behaviour if using it directly to get articles set this TRUE (default FALSE)
364:      * @param string $sortorder "date" (default), "title", "popular", "mostrated", "toprated", "random"
365:      *                                                  This parameter is not used for date archives
366:      * @param string $sortdirection "asc" or "desc" for ascending or descending order
367:      *                                                  This parameter is not used for date archives
368:      * @param bool $sticky set to true to place "sticky" articles at the front of the list.
369:      * @return array
370:      */
371:     function getArticles($articles_per_page = 0, $published = NULL, $ignorepagination = false, $sortorder = NULL, $sortdirection = NULL, $sticky = NULL) {
372:         global $_zp_zenpage;
373:         return $_zp_zenpage->getArticles($articles_per_page, $published, $ignorepagination, $sortorder, $sortdirection, $sticky, $this);
374:     }
375: 
376:     /**
377:      * Returns an article from the album based on the index passed.
378:      *
379:      * @param int $index
380:      * @return int
381:      */
382:     function getArticle($index, $published = NULL, $sortorder = 'date', $sortdirection = 'desc', $sticky = true) {
383:         $articles = $this->getArticles(0, $published, true, $sortorder, $sortdirection, $sticky); // pagination not needed
384:         if ($index >= 0 && $index < count($articles)) {
385:             return $articles[$index];
386:         }
387:         return false;
388:     }
389: 
390:     /**
391:      * Get the index of this article
392:      *
393:      * @return int
394:      */
395:     function getIndex($sortorder, $sortdirection, $sticky) {
396:         global $_zp_zenpage, $_zp_current_zenpage_news;
397:         if ($this->index == NULL) {
398:             $articles = $_zp_zenpage->getArticles(0, NULL, true, $sortorder, $sortdirection, $sticky);
399:             for ($i = 0; $i < count($articles); $i++) {
400:                 $article = $articles[$i];
401:                 if ($this->getTitlelink() == $article['titlelink']) {
402:                     $this->index = $i;
403:                     break;
404:                 }
405:             }
406:         }
407:         return $this->index;
408:     }
409: 
410:     /**
411:      * Return the previous article
412:      *
413:      * @return object
414:      */
415:     function getPrevArticle($sortorder = 'date', $sortdirection = 'desc', $sticky = true) {
416:         global $_zp_zenpage, $_zp_current_zenpage_news;
417:         $index = $this->getIndex($sortorder, $sortdirection, $sticky);
418:         $article = $this->getArticle($index - 1);
419:         return $article;
420:     }
421: 
422:     /**
423:      * Returns the next article.
424:      *
425:      * @return object
426:      */
427:     function getNextArticle($sortorder = 'date', $sortdirection = 'desc', $sticky = true) {
428:         global $_zp_zenpage, $_zp_current_zenpage_news;
429:         $index = $this->getIndex($sortorder, $sortdirection, $sticky);
430:         $article = $this->getArticle($index + 1);
431:         return $article;
432:     }
433: 
434:     /**
435:      * Returns the full path to a news category
436:      *
437:      * @param string $page The category page number
438:      *
439:      * @return string
440:      */
441:     function getLink($page = NULL) {
442:         global $_zp_zenpage;
443:         if ($page > 1) {
444:             $pager = $page . '/';
445:             $page = '&page=' . $page;
446:         } else {
447:             $pager = $page = '';
448:         }
449:         return zp_apply_filter('getLink', rewrite_path(_CATEGORY_ . '/' . $this->getTitlelink() . '/' . $pager, "/index.php?p=news&category=" . $this->getTitlelink() . $page), $this, NULL);
450:     }
451: 
452:     /**
453:      *
454:      * @global type $_zp_zenpage
455:      * @return type
456:      * @deprecated
457:      */
458:     function getCategoryLink() {
459:         Zenpage_internal_deprecations::getCategoryLink();
460:         return $this->getLink();
461:     }
462: 
463: }
464: 
465: // zenpage news category class end
466: ?>