Add notifications to feed entries

.gitignore

@@ -1,5 +1,6 @@
 /nbproject/*
 /config/*
+.DS_Store
 !.gitignore
 .DS_Store
 /vendor/.composer/

README.md

@@ -14,16 +14,7 @@ https://docs.phraseanet.com/3.6/
 
 #Easy Installation
 
-**Fetch Sources**
-
-<pre>
-
-git clone git://github.com/alchemy-fr/Phraseanet.git Phraseanet
-cd Phraseanet
-./vendors.php
-
-</pre>
-
+Get the latests sources here https://github.com/alchemy-fr/Phraseanet/downloads
 
 **Setup your webserver**
 

lib/Alchemy/Phrasea/Application/Lightbox.php

@@ -570,7 +570,7 @@ return call_user_func(
             $expires = new \DateTime('+10 days');
             $url     = $appbox->get_registry()->get('GV_ServerName')
               . 'lightbox/index.php?LOG=' . \random::getUrlToken(
-                'validate'
+                \random::TYPE_VALIDATE
                 , $basket->getValidation()->getInitiator()->get_id()
                 , $expires
                 , $basket->getId()

lib/Alchemy/Phrasea/Controller/Prod/Push.php

@@ -258,7 +258,7 @@ class Push implements ControllerProviderInterface
 
             $url = $registry->get('GV_ServerName')
               . 'lightbox/index.php?LOG='
-              . \random::getUrlToken('view', $user_receiver->get_id(), null, $Basket->getId());
+              . \random::getUrlToken(\random::TYPE_VIEW, $user_receiver->get_id(), null, $Basket->getId());
 
             $params = array(
               'from'       => $user->get_id()
@@ -489,7 +489,7 @@ class Push implements ControllerProviderInterface
 
             $url = $registry->get('GV_ServerName')
               . 'lightbox/index.php?LOG='
-              . \random::getUrlToken('view', $participant_user->get_id(), null, $Basket->getId());
+              . \random::getUrlToken(\random::TYPE_VIEW, $participant_user->get_id(), null, $Basket->getId());
 
             $params = array(
               'from'       => $user->get_id()

lib/classes/Feed/Entry/Adapter.class.php

@@ -411,7 +411,6 @@ class Feed_Entry_Adapter implements Feed_Entry_Interface, cache_cacheableInterfa
   public function get_content()
   {
     if ($this->items)
-
       return $this->items;
 
     $rs    = $this->retrieve_elements();
@@ -531,7 +530,12 @@ class Feed_Entry_Adapter implements Feed_Entry_Interface, cache_cacheableInterfa
 
     $feed->delete_data_from_cache();
 
-    return new self($appbox, $feed, $entry_id);
+    $entry = new self($appbox, $feed, $entry_id);
+
+    $eventsmanager = \eventsmanager_broker::getInstance($appbox);
+    $eventsmanager->trigger('__FEED_ENTRY_CREATE__', array('entry_id' => $entry_id), $entry);
+
+    return $entry;
   }
 
   /**

lib/classes/User/Adapter.class.php

@@ -466,7 +466,7 @@ class User_Adapter implements User_Interface, cache_cacheableInterface
     }
     if ($token === false)
     {
-      $token = random::getUrlToken('rss', $this->id);
+      $token = random::getUrlToken(\random::TYPE_RSS, $this->id);
     }
 
     return new system_url($registry->get('GV_ServerName') . 'atom/' . $token);

lib/classes/eventsmanager/broker.class.php

@@ -27,7 +27,7 @@ class eventsmanager_broker
   }
 
   /**
-   * @return eventsmanager
+   * @return \eventsmanager_broker
    */
   public static function getInstance(appbox &$appbox, \Alchemy\Phrasea\Core $core)
   {

lib/classes/eventsmanager/notify/feed.class.php

@@ -0,0 +1,208 @@
+<?php
+
+/*
+ * This file is part of Phraseanet
+ *
+ * (c) 2005-2010 Alchemy
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ *
+ *
+ * @license     http://opensource.org/licenses/gpl-3.0 GPLv3
+ * @link        www.phraseanet.com
+ */
+class eventsmanager_notify_feed extends eventsmanager_notifyAbstract
+{
+
+  /**
+   *
+   * @var string
+   */
+  public $events = array('__FEED_ENTRY_CREATE__');
+
+  /**
+   *
+   * @return string
+   */
+  public function icon_url()
+  {
+    return '/skins/icons/rss16.png';
+  }
+
+  /**
+   *
+   * @param string $event
+   * @param Array $params
+   * @param mixed content $object
+   * @return boolean
+   */
+  public function fire($event, $params, &$entry)
+  {
+    $params = array(
+      'entry_id' => $entry->get_id()
+    );
+
+    $dom_xml = new DOMDocument('1.0', 'UTF-8');
+
+    $dom_xml->preserveWhiteSpace = false;
+    $dom_xml->formatOutput = true;
+
+    $root = $dom_xml->createElement('datas');
+
+    $entry_id = $dom_xml->createElement('entry_id');
+
+    $entry_id->appendChild($dom_xml->createTextNode($params['entry_id']));
+
+    $root->appendChild($entry_id);
+
+    $dom_xml->appendChild($root);
+
+    $datas = $dom_xml->saveXml();
+
+    $Query = new \User_Query($this->appbox);
+
+    $Query->include_phantoms(true)->include_invite(false)->include_templates(false);
+
+    if ($entry->get_feed()->get_collection())
+    {
+      $Query->on_base_ids(array($entry->get_feed()->get_collection()->get_base_id()));
+    }
+
+    $start   = 0;
+    $perLoop = 100;
+
+    $from = array(
+      'email' => $entry->get_author_email(),
+      'name'  => $entry->get_author_name()
+    );
+
+    do
+    {
+      $results = $Query->limit($start, $perLoop)->execute()->get_results();
+
+      foreach ($results as $user_to_notif)
+      {
+        /* @var $user_to_notif \User_Adapter */
+        $mailed = false;
+
+        $send_notif = ($this->get_prefs(__CLASS__, $user_to_notif->get_id()) != '0');
+        if ($send_notif)
+        {
+          $email = array(
+            'email' => $user_to_notif->get_email(),
+            'name'  => $user_to_notif->get_display_name()
+          );
+
+          $token = \random::getUrlToken(
+              \random::TYPE_FEED_ENTRY
+              , $user_to_notif->get_id()
+              , null
+              , $entry->get_id()
+          );
+
+          $url = $this->appbox->get_registry()->get('GV_ServerName') . 'lightbox/index.php?LOG=' . $token;
+
+          if (self::mail($email, $from, $url, $entry))
+            $mailed = true;
+        }
+
+        $this->broker->notify($user_to_notif->get_id(), __CLASS__, $datas, $mailed);
+      }
+      $start += $perLoop;
+    }
+    while (count($results) > 0);
+
+    return true;
+  }
+
+  /**
+   *
+   * @param Array $datas
+   * @param boolean $unread
+   * @return Array
+   */
+  public function datas($datas, $unread)
+  {
+    $sx = simplexml_load_string($datas);
+
+    try
+    {
+      $entry = \Feed_Entry_Adapter::load_from_id($this->appbox, (int) $sx->entry_id);
+    }
+    catch (\Exception $e)
+    {
+      return array();
+    }
+
+    $ret = array(
+      'text'  => sprintf(
+        _('%1$s has published %2$s')
+        , $entry->get_author_name()
+        , '<a href="/lightbox/feeds/entry/' . $entry->get_id() . '/" target="_blank">' . $entry->get_title() . '</a>'
+      )
+      , 'class' => ($unread == 1 ? 'reload_baskets' : '')
+    );
+
+    return $ret;
+  }
+
+  /**
+   *
+   * @return string
+   */
+  public function get_name()
+  {
+    return _('Feeds');
+  }
+
+  /**
+   *
+   * @return string
+   */
+  public function get_description()
+  {
+    return _('Recevoir des notifications lorsqu\'on me push quelque chose');
+  }
+
+  /**
+   *
+   * @return boolean
+   */
+  function is_available()
+  {
+    return true;
+  }
+
+  /**
+   *
+   * @param Array $to
+   * @param Array $from
+   * @param string $message
+   * @param string $url
+   * @param boolean $accuse
+   * @return boolean
+   */
+  function mail($to, $from, $url, \Feed_Entry_Adapter $entry)
+  {
+    $subject = sprintf(_('Nouvelle publication : %s'), $entry->get_title());
+
+    $body = "<div>"
+      . sprintf('%s vient de publier %s', $entry->get_author_name(), $entry->get_title())
+      . _('Connectez vous a l\'adresse suivante pour la consulter')
+      . "</div>\n";
+
+    $body .= '<div><a href="' . $url . '">' . $url . "</a></div>\n";
+
+    $body .= " <br/> ";
+
+    $body .= "<br/>\n<br/>\n<br/>\n"
+      . _('push::atention: ce lien est unique et son contenu confidentiel, ne divulguez pas');
+
+    return mail::send_mail($subject, $body, $to, $from, array());
+  }
+
+}

lib/classes/gatekeeper.class.php

@@ -79,7 +79,6 @@ class gatekeeper
     $session = $appbox->get_session();
 
     if (http_request::is_command_line())
-
       return;
 
     if (isset($_SERVER['PHP_SELF']) && trim($_SERVER['PHP_SELF']))
@@ -141,7 +140,6 @@ class gatekeeper
           break;
         case 'admin':
           if ($this->_script_name === 'runscheduler.php')
-
             return;
           phrasea::redirect('/login/?redirect=' . $_SERVER['REQUEST_URI']);
           break;
@@ -161,7 +159,6 @@ class gatekeeper
           return;
         case 'setup':
           if ($appbox->upgradeavailable())
-
             return;
           else
             phrasea::redirect('/login/');
@@ -278,7 +275,6 @@ class gatekeeper
     $parm    = $request->get_parms('LOG');
 
     if (is_null($parm["LOG"]))
-
       return $this;
 
     try
@@ -297,7 +293,19 @@ class gatekeeper
     {
       $datas = random::helloToken($parm['LOG']);
 
+      switch ($datas['type'])
+      {
+        default:
+          return $this;
+          break;
+        case \random::TYPE_FEED_ENTRY:
+          return phrasea::redirect("/lightbox/feeds/entry/" . $datas['datas'] . "/");
+          break;
+        case \random::TYPE_VALIDATE:
+        case \random::TYPE_VIEW:
           return phrasea::redirect("/lightbox/validate/" . $datas['datas'] . "/");
+          break;
+      }
     }
     catch (Exception_NotFound $e)
     {

lib/classes/mail.class.php

@@ -127,7 +127,7 @@ class mail
   {
     $registry = registry::get_instance();
     $date = new DateTime('1 day');
-    $token = random::getUrlToken('email', $usr_id, $date, $email);
+    $token = random::getUrlToken(\random::TYPE_EMAIL, $usr_id, $date, $email);
 
     $url = $registry->get('GV_ServerName') . 'login/reset-email.php?token=' . $token;
 
@@ -174,7 +174,7 @@ class mail
   {
     $registry = registry::get_instance();
     $expire = new DateTime('+3 days');
-    $token = random::getUrlToken('password', $usr_id, $expire, $email);
+    $token = random::getUrlToken(\random::TYPE_PASSWORD, $usr_id, $expire, $email);
 
     $subject = _('login::register: sujet email : confirmation de votre adresse email');
 

lib/classes/random.class.php

@@ -11,9 +11,11 @@
 
 class random
 {
+
   /**
    *
    */
+
   const NUMBERS             = "0123456789";
   /**
    *
@@ -23,6 +25,14 @@ class random
    *
    */
   const LETTERS_AND_NUMBERS = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
+  const TYPE_FEED_ENTRY     = 'FEED_ENTRY';
+  const TYPE_PASSWORD       = 'password';
+  const TYPE_DOWNLOAD       = 'download';
+  const TYPE_MAIL_DOWNLOAD  = 'mail-download';
+  const TYPE_EMAIL          = 'email';
+  const TYPE_VIEW           = 'view';
+  const TYPE_VALIDATE       = 'validate';
+  const TYPE_RSS            = 'rss';
 
   /**
    *
@@ -112,8 +122,22 @@ class random
     $conn  = connection::getPDOConnection();
     $token = $test  = false;
 
-    if (!in_array($type, array('password', 'download', 'mail-download', 'email', 'view', 'validate', 'rss')))
+    switch ($type)
+    {
+      case self::TYPE_DOWNLOAD:
+      case self::TYPE_PASSWORD:
+      case self::TYPE_MAIL_DOWNLOAD:
+      case self::TYPE_EMAIL:
+      case self::TYPE_VALIDATE:
+      case self::TYPE_VIEW:
+      case self::TYPE_RSS:
+      case self::TYPE_FEED_ENTRY:
+
+        break;
+      default:
         throw new Exception_InvalidArgument();
+        break;
+    }
 
     $n = 1;
 

lib/conf.d/bases_structure.xml

@@ -3816,7 +3816,7 @@
           </field>
           <field>
             <name>type</name>
-            <type>enum('view','validate','password','rss','email','download')</type>
+            <type>enum('FEED_ENTRY', 'view','validate','password','rss','email','download')</type>
             <null></null>
             <extra></extra>
             <collation>ascii_bin</collation>

lib/unitTest/randomTest.php

@@ -13,7 +13,7 @@ class randomTest extends PhraseanetPHPUnitAbstract
   {
     $expires_on = new DateTime('-5 minutes');
     $usr_id = self::$user->get_id();
-    $token = random::getUrlToken('password', $usr_id, $expires_on, 'some nice datas');
+    $token = random::getUrlToken(\random::TYPE_PASSWORD, $usr_id, $expires_on, 'some nice datas');
     random::cleanTokens();
 
     try
@@ -76,7 +76,7 @@ class randomTest extends PhraseanetPHPUnitAbstract
   public function testGetUrlToken()
   {
     $usr_id = self::$user->get_id();
-    $token = random::getUrlToken('password', $usr_id, null, 'some nice datas');
+    $token = random::getUrlToken(\random::TYPE_PASSWORD, $usr_id, null, 'some nice datas');
     $datas = random::helloToken($token);
     $this->assertEquals('some nice datas', $datas['datas']);
     random::updateToken($token, 'some very nice datas');
@@ -101,7 +101,7 @@ class randomTest extends PhraseanetPHPUnitAbstract
   public function testHelloToken()
   {
     $usr_id = self::$user->get_id();
-    $token = random::getUrlToken('password', $usr_id, null, 'some nice datas');
+    $token = random::getUrlToken(\random::TYPE_PASSWORD, $usr_id, null, 'some nice datas');
     $datas = random::helloToken($token);
     $this->assertEquals('some nice datas', $datas['datas']);
     $this->assertNull($datas['expire_on']);
@@ -125,7 +125,7 @@ class randomTest extends PhraseanetPHPUnitAbstract
 
     $expires_on = new DateTime('+5 minutes');
     $usr_id = self::$user->get_id();
-    $token = random::getUrlToken('password', $usr_id, $expires_on, 'some nice datas');
+    $token = random::getUrlToken(\random::TYPE_PASSWORD, $usr_id, $expires_on, 'some nice datas');
     $datas = random::helloToken($token);
     $this->assertEquals('some nice datas', $datas['datas']);
     $sql_expires = new DateTime($datas['expire_on']);
@@ -151,7 +151,7 @@ class randomTest extends PhraseanetPHPUnitAbstract
 
     $expires_on = new DateTime('-5 minutes');
     $usr_id = self::$user->get_id();
-    $token = random::getUrlToken('password', $usr_id, $expires_on, 'some nice datas');
+    $token = random::getUrlToken(\random::TYPE_PASSWORD, $usr_id, $expires_on, 'some nice datas');
 
     try
     {

lib/unitTest/record/adapterTest.php

@@ -384,7 +384,18 @@ class record_adapterTest extends PhraseanetPHPUnitAuthenticatedAbstract
       $this->assertEquals(1, count($current_fields));
       $field = $current_fields[0];
 
-      $multi_imploded = implode(' ' . $meta_el->get_separator() . ' ', array('un', 'jeu', 'de', 'test'));
+      $separator = $meta_el->get_separator();
+
+      if(strlen($separator) > 0)
+      {
+        $separator = $separator[0];
+      }
+      else
+      {
+        $separator = '';
+      }
+
+      $multi_imploded = implode(' ' . $separator . ' ', array('un', 'jeu', 'de', 'test'));
 
       if ($meta_el->is_multi())
       {

www/include/download.php

@@ -56,7 +56,7 @@ $list['export_name'] = $exportname . '.zip';
 
 $endDate = new DateTime('+3 hours');
 
-$url = random::getUrlToken('download', $session->get_usr_id(), $endDate, serialize($list));
+$url = random::getUrlToken(\random::TYPE_DOWNLOAD, $session->get_usr_id(), $endDate, serialize($list));
 
 if ($url)
 {

www/include/sendmailpage.php

@@ -61,7 +61,7 @@ $list['email'] = $Request->get("destmail", "");
 $endate_obj = new DateTime('+1 day');
 $endDate = $endate_obj;
 
-$token = random::getUrlToken('email', false, $endDate, serialize($list));
+$token = random::getUrlToken(\random::TYPE_EMAIL, false, $endDate, serialize($list));
 
 //GET EMAILS
 

www/login/authenticate.php

@@ -108,7 +108,7 @@ if ((!is_null($parm['login']) && !is_null($parm['pwd'])) || $is_guest)
   {
     $date = new DateTime('5 minutes');
     $usr_id = User_Adapter::get_usr_id_from_login($parm['login']);
-    $url = random::getUrlToken('password', $usr_id, $date);
+    $url = random::getUrlToken(\random::TYPE_PASSWORD, $usr_id, $date);
 
     $url = '/login/forgotpwd.php?token=' . $url . '&salt=1';
 

www/login/forgotpwd.php

@@ -46,7 +46,7 @@ if (isset($parm["mail"]) && trim($parm["mail"]) != "")
   }
 
   $date = new DateTime('1 day');
-  $url = random::getUrlToken('password', $user->get_id(), $date);
+  $url = random::getUrlToken(\random::TYPE_PASSWORD, $user->get_id(), $date);
 
   if ($url !== false)
   {

www/prod/page0.js

@@ -3163,7 +3163,17 @@ function set_up_feed_box(data)
       url: $form.attr('action'),
       data: $form.serializeArray(),
       dataType:'json',
+      beforeSend:function(){
+        $('button', $feed_box).attr('disabled', 'disabled');
+      },
+      error:function(){
+        $('button', $feed_box).removeAttr('disabled');
+      },
+      timeout:function(){
+        $('button', $feed_box).removeAttr('disabled');
+      },
       success: function(data){
+        $('button', $feed_box).removeAttr('disabled');
         if(data.error === true)
         {
           alert(data.message);