DMSession.php

<?php
#
# dmBridge: a data access framework for CONTENTdm(R)
#
# Copyright © 2009, 2010, 2011 Board of Regents of the Nevada System of Higher
# Education, on behalf of the University of Nevada, Las Vegas
#

final class DMSession {

   private $favorites = array();

   public function __construct() {
      $this->populateFavorites();
   }

   public function addFavorite(DMObject $obj) {
      // check for duplicates
      foreach ($this->favorites as $fav) {
         if ($fav->equals($obj)) {
            return;
         }
      }

      if (!array_key_exists('BUF', $_COOKIE)) {
         $_COOKIE['BUF'] = "";
      }
      $buf = &$_COOKIE['BUF'];
      $objcookie = sprintf("%s<%d>",
            $obj->getCollection()->getAlias(),
            $obj->getPtr());
      if (strpos($buf, $objcookie) === false) {
         $buf .= $objcookie;
         if (!headers_sent()) {
            setcookie('BUF', $buf, null, '/');
         }
      }
      $this->favorites[] = $obj;
   }

   public function getAccessibleFavorites(DMTemplateSet $template_set) {
      $objects = array();
      foreach ($this->getAllFavorites() as $obj) {
         if ($template_set
               ->isAuthorizedToViewCollection($obj->getCollection())) {
            $objects[] = $obj;
         }
      }
      return $objects;
   }

   public function getAllFavorites() {
      return $this->favorites;
   }

   public function deleteFavorites(array $objects) {
      if (array_key_exists("BUF", $_COOKIE)) {
         $buf = $_COOKIE['BUF'];
         foreach ($objects as &$obj) {
            // delete it from the cookie
            $buf = str_replace(
               sprintf("%s<%d>",
                     $obj->getCollection()->getAlias(),
                     $obj->getPtr()),
                  "", $buf);
            // delete it from the instance
            for ($i = 0; $i < count($this->favorites); $i++) {
               if ($obj->equals($this->favorites[$i])) {
                  unset($this->favorites[$i]);
                  break;
               }
            }
            // delete it from the passed-in array
            $obj = null;
         }
         if (!headers_sent()) {
            setcookie("BUF", $buf, null, "/");
         }
      }
   }

   private function populateFavorites() {
      if (count($this->getAllFavorites()) < 1) {
         if (array_key_exists('BUF', $_COOKIE)) {
            $pairs = explode('>', $_COOKIE['BUF']);
            array_pop($pairs);
            foreach ($pairs as $pair) {
               $tmp = explode('<', $pair);
               $this->favorites[] = DMObjectFactory::getObject(
                     DMCollectionFactory::getCollection(
                           DMCollection::getSanitizedAlias($tmp[0])),
                     $tmp[1]);
            }
         }
      }
   }

   public function getFlash() {
      if (array_key_exists('flash', $_SESSION)) {
         return ($_SESSION['flash'] instanceof DMFlash)
            ? $_SESSION['flash'] : null;
      }
   }

   public function setFlash(DMFlash $flash) {
      $_SESSION['flash'] = $flash;
   }

   public function unsetFlash() {
      $_SESSION['flash'] = null;
   }

   public function hasCommentedOnObject(DMObject $obj) {
      if (!array_key_exists('has_commented', $_SESSION)) {
         return false;
      }
      if (!is_array($_SESSION['has_commented'])) {
         return false;
      }
      foreach ($_SESSION['has_commented'] as $arr) {
         if ($arr['alias'] == $obj->getCollection()->getAlias()
               && $arr['ptr'] == $obj->getPtr()) {
            return true;
         }
      }
      return false;
   }

   public function addHasCommented(DMObject $obj) {
      if (self::hasCommentedOnObject($obj)) {
         return;
      }
      if (!array_key_exists('has_commented', $_SESSION)
            || !is_array($_SESSION['has_commented'])) {
         $_SESSION['has_commented'] = array();
      }
      // if $obj is a child object, add all siblings as well as the parent
      if ($obj->isChild()) {
         $objects = $obj->getParent()->getChildren();
         $objects[] = $obj->getParent();
      } else if ($obj->isCompound()) {
         // if it's a compound object, add all children
         $objects = $obj->getChildren();
         $objects[] = $obj;
      } else { // it's a lonely DMObject
         $objects = array($obj);
      }
      foreach ($objects as $o) {
         $_SESSION['has_commented'][] = array(
            'alias' => $o->getCollection()->getAlias(),
            'ptr' => $o->getPtr()
         );
      }
   }

   public function hasRated() {
      return (array_key_exists("has_rated", $_SESSION)
            && is_array($_SESSION['has_rated']))
            ? $_SESSION['has_rated'] : array();
   }

   public function hasRatedObject(DMObject $obj) {
      if (array_key_exists('has_rated', $_SESSION)) {
         if (is_array($_SESSION['has_rated'])) {
            foreach ($_SESSION['has_rated'] as $arr) {
               if ($arr['alias'] == $obj->getCollection()->getAlias()
               && $arr['ptr'] == $obj->getPtr()) {
                  return true;
               }
            }
         }
      }
      return false;
   }

   public function addHasRated(DMObject $obj) {
      if (!self::hasRatedObject($obj)) {
         if (!array_key_exists("has_rated", $_SESSION)
         || !is_array($_SESSION['has_rated'])) {
            $_SESSION['has_rated'] = array();
         }
         $_SESSION['has_rated'][] = array(
            'alias' => $obj->getCollection()->getAlias(),
            'ptr' => $obj->getPtr()
         );
      }
   }

   public function getQuery() {
      return (array_key_exists('query', $_SESSION)
            && $_SESSION['query'] instanceof DMQuery)
            ? $_SESSION['query'] : null;
   }

   public function setQuery(DMQuery $q) {
      $_SESSION['query'] = $q;
   }

   public function unsetQuery() {
      $_SESSION['query'] = null;
   }

   public function addRecentlyViewedObject(DMObject $obj) {
      $k = "recently_viewed_objects";
      if (!array_key_exists($k, $_SESSION) || !is_array($_SESSION[$k])) {
         $_SESSION[$k] = array();
      }
      if (count($_SESSION[$k]) > 0
            && $obj->equals($_SESSION[$k][count($_SESSION[$k]) - 1])) {
         return;
      }
      $_SESSION[$k][] = $obj;
   }

   public function getRecentlyViewedObjects($limit) {
      $k = "recently_viewed_objects";
      $objects = array();
      if (array_key_exists($k, $_SESSION) && is_array($_SESSION[$k])) {
         foreach ($_SESSION[$k] as $obj) {
            if (count($objects) >= $limit) {
               break;
            }
            foreach ($objects as $obj2) {
               if ($obj2->equals($obj)) {
                  continue(2);
               }
            }
            $objects[] = $obj;
         }
      }
      return $objects;
   }

   public function getResultsView() {
      return array_key_exists("results_view", $_SESSION)
         ? $_SESSION['results_view'] : null;
   }

   public function setResultsView(DMResultsView $view) {
      $_SESSION['results_view'] = $view;
   }

   public function unsetResultsView() {
      $_SESSION['results_view'] = null;
   }

   public function getSearchInput() {
      return (array_key_exists("search_input", $_SESSION))
         ? $_SESSION['search_input'] : null;
   }

   public function setSearchInput(DMInput $input) {
      $_SESSION['search_input'] = $input;
   }

   public function unsetSearchInput() {
      $_SESSION['search_input'] = null;
   }

   public function getUser() {
      return (array_key_exists("user", $_SESSION))
            ? $_SESSION['user'] : null;
   }

   public function setUser(DMUser $user) {
      $_SESSION['user'] = $user;
   }

   public function unsetUser() {
      $_SESSION['user'] = null;
   }

}