Enhance the Watchlist block (Bug #1516981)

Enhance the "Watched pages" block to configure it so as to
display changes relating to users' friends since their last
login of different time frame (e.g. last week, last month,
last quarter, last year, etc.).

behatnotneeded: Tests will be written later.

Change-Id: I0ed978a5070120e5b32e79d25f99c2bca84feb20
Signed-off-by: Gregor Anzelj <gregor.anzelj@gmail.com>

htdocs/blocktype/watchlist/js/configform.js

+function toggle_watchlist_type_class(value, state) {
+    $j('#instconf_settings_header').toggleClass(value, state);
+    $j('#instconf_settings_container').toggleClass(value, state);
+    $j('#instconf_settings_header fieldset').toggleClass(value, state);
+    $j('#instconf_settings_container fieldset').toggleClass(value, state);
+}
+$j('#instconf_mode_container input[type="radio"][value="watchlist"]').on('click', function() {
+    toggle_watchlist_type_class('hidden', true);
+});
+$j('#instconf_mode_container input[type="radio"][value="follower"]').on('click', function() {
+    toggle_watchlist_type_class('hidden', false);
+});
+$j(function() {
+    if ($j('#instconf_mode_container input[type="radio"]:checked').val() == 'watchlist') {
+        toggle_watchlist_type_class('hidden', true);
+    }
+});

htdocs/blocktype/watchlist/lang/en.utf8/blocktype.watchlist.php

@@ -4,6 +4,7 @@
  * @package    mahara
  * @subpackage blocktype-watchlist
  * @author     Catalyst IT Ltd
+ * @author     Gregor An¸elj <gregor.anzelj@gmail.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
  * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
  *
@@ -16,3 +17,25 @@ $string['defaulttitledescription'] = 'A default title will be generated if you l
 $string['description'] = 'Display pages on your watchlist';
 $string['nopages'] = 'There are no pages on your watchlist.';
 $string['itemstoshow'] = 'Items to show';
+
+$string['typetoshow'] = 'Display';
+$string['typetoshowdesc'] = 'Select whether to display pages from your watchlist or portfolios your friends created on your dashboard.';
+$string['noactivities'] = 'There is nothing to display for the selected time period.';
+$string['list.watchlist'] = 'Pages on my watchlist';
+$string['list.follower'] = 'Activities of my friends';
+$string['additionalfilters'] = 'Additional filters and settings';
+
+$string['filterby'] = 'Filter by time';
+$string['filterbydesc'] = 'Select the time period from which you want to display activities.';
+$string['filterby.week'] = 'Last week';
+$string['filterby.month'] = 'Last month';
+$string['filterby.2months'] = 'Last 2 months';
+$string['filterby.quarter'] = 'Last 3 months';
+$string['filterby.half'] = 'Last 6 months';
+$string['filterby.year'] = 'Last year';
+$string['filterby.login'] = 'Since last login';
+
+$string['orderby'] = 'Order by';
+$string['orderbydesc'] = 'Select to show pages in reverse chronological order or by page owner.';
+$string['orderby.activity'] = 'Reverse chronological order';
+$string['orderby.owner'] = 'Page owner';

htdocs/blocktype/watchlist/lib.php

@@ -4,6 +4,7 @@
  * @package    mahara
  * @subpackage blocktype-watchlist
  * @author     Catalyst IT Ltd
+ * @author     Gregor Anželj <gregor.anzelj@gmail.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
  * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
  *
@@ -42,6 +43,7 @@ class PluginBlocktypeWatchlist extends MaharaCoreBlocktype {
             $smarty->assign('watchlistempty', true);
         }
         else {
+            $smarty->assign('watchlistempty', false);
             $smarty->assign('watchlist', $views);
         }
         return $smarty->fetch('blocktype:watchlist:watchlist.tpl');
@@ -60,24 +62,75 @@ class PluginBlocktypeWatchlist extends MaharaCoreBlocktype {
         global $USER;
 
         $configdata = $instance->get('configdata');
-        $limit = isset($configdata['count']) ? (int) $configdata['count'] : 10;
-        $userid = $USER->get('id');
-
-        $count = count_records_sql('SELECT COUNT(*) FROM {view} v JOIN {usr_watchlist_view} wv ON wv.view = v.id WHERE wv.usr = ?' , array($userid));
-        $sql = '
-            SELECT v.id, v.title, v.owner, v.group, v.institution, v.ownerformat, v.urlid, v.ctime, v.mtime
-            FROM {view} v
-            JOIN {usr_watchlist_view} wv ON wv.view = v.id
-            WHERE wv.usr = ?
-            ORDER BY v.title';
-        $results = get_records_sql_assoc($sql, array($userid), $offset, $limit);
-
-        if (!empty($results)) {
-            View::get_extra_view_info($results, false, false);
-            foreach ($results as &$r) {
-                $r = (object) $r;
-            }
+        $mode    = isset($configdata['mode']) ? $configdata['mode'] : 'watchlist';
+        $period  = isset($configdata['period']) ? $configdata['period'] : 'login';
+        $orderby = $mode == 'watchlist' ? '' : (isset($configdata['orderby']) ? $configdata['orderby'] : 'activity');
+        $limit   = isset($configdata['count']) ? (int) $configdata['count'] : 10;
+        $view = $instance->get_view();
+        $userid = $view->get('owner');
+
+        $results = array();
+        $count = 0;
+        switch ($mode) {
+            case 'follower':
+                // All viewable views (from friends), excluding user's own views
+                require_once('searchlib.php');
+                $friends = search_friend('current');
+                $ownedby = null;
+                if ($friends['count'] > 0) {
+                    $ownedby = array();
+                    foreach ($friends['data'] as $friend) {
+                        $ownedby[] = (object) array('owner' => $friend['id']);
+                    }
+                }
+                $sort[] = array('column' => 'mtime', 'desc' => true);
+                $results = View::view_search(
+                    null, // $query
+                    null, // $ownerquery
+                    $ownedby, // $ownedby
+                    null, // $copyableby
+                    $limit, // $limit
+                    0, // $offset
+                    true, // $extra
+                    $sort, // $sort
+                    array('portfolio'), // $types
+                    null, // $collection
+                    null, // $accesstypes
+                    null, // $tag
+                    null, // $viewid
+                    $userid, // $excludeowner
+                    false  // $groupbycollection
+                );
+
+                $options = new StdClass();
+                $options->period = $period;
+                $options->orderby = $orderby;
+                if ($results->count > 0) {
+                    // Pages shared to user filtered according to date/time frame and filter
+                    list($results, $count) = self::filter_views_shared_to_user($results->data, $options);
+                }
+                break;
+
+            case 'watchlist':
+            default:
+                $count = count_records_sql('SELECT COUNT(*) FROM {view} v JOIN {usr_watchlist_view} wv ON wv.view = v.id WHERE wv.usr = ?' , array($userid));
+                $sql = '
+                    SELECT v.id, v.title, v.owner, v.group, v.institution, v.ownerformat, v.urlid, v.ctime, v.mtime
+                    FROM {view} v
+                    JOIN {usr_watchlist_view} wv ON wv.view = v.id
+                    WHERE wv.usr = ?
+                    ORDER BY v.title';
+                $results = get_records_sql_assoc($sql, array($userid), $offset, $limit);
+
+                if (!empty($results)) {
+                    View::get_extra_view_info($results, false, false);
+                    foreach ($results as &$r) {
+                        $r = (object) $r;
+                    }
+                }
+                break;
         }
+
         $views = array('data' => $results,
                        'offset' => $offset,
                        'limit' => $limit,
@@ -100,7 +153,9 @@ class PluginBlocktypeWatchlist extends MaharaCoreBlocktype {
         $smarty->assign('options', array());
         $smarty->assign('views', $views['data']);
         $smarty->assign('loggedin', $USER->is_logged_in());
-        $views['tablerows'] = $smarty->fetch('blocktype:watchlist:watchlistpaginator.tpl');
+        $smarty->assign('order', $orderby);
+
+        $views['tablerows'] = $smarty->fetch('blocktype:watchlist:' . $mode . $orderby . 'paginator.tpl');
 
         if ($views['limit'] && $pagination) {
             $pagination = build_pagination(array(
@@ -127,11 +182,64 @@ class PluginBlocktypeWatchlist extends MaharaCoreBlocktype {
         return true;
     }
 
+    public static function get_instance_config_javascript(BlockInstance $instance) {
+        return array('js/configform.js');
+    }
+
     public static function instance_config_form(BlockInstance $instance) {
         $configdata = $instance->get('configdata');
+        $classes = 'first last';
+        if (!isset($configdata) || (isset($configdata['mode']) && $configdata['mode'] == 'watchlist')) {
+            $classes .= ' hidden';
+        }
 
         return array(
-            'count'     => array(
+            'mode' => array(
+                'type'          => 'radio',
+                'title'         => get_string('typetoshow', 'blocktype.watchlist'),
+                'description'   => get_string('typetoshowdesc', 'blocktype.watchlist'),
+                'defaultvalue'  => isset($configdata['mode']) ? $configdata['mode'] : 'watchlist',
+                'options'       => array(
+                    'watchlist'      => get_string('list.watchlist', 'blocktype.watchlist'),
+                    'follower'    => get_string('list.follower', 'blocktype.watchlist'),
+                ),
+            ),
+            'settings' => array(
+                'type' => 'fieldset',
+                'class' => $classes,
+                'iconclass' => 'filter',
+                'collapsible' => true,
+                'collapsed' => true,
+                'legend' => get_string('additionalfilters', 'blocktype.watchlist'),
+                'elements' => array(
+                    'period' => array(
+                        'type'        => 'select',
+                        'title'       => get_string('filterby', 'blocktype.watchlist'),
+                        'description' => get_string('filterbydesc', 'blocktype.watchlist'),
+                        'options' => array(
+                            'week' => get_string('filterby.week', 'blocktype.watchlist'),
+                            'month' => get_string('filterby.month', 'blocktype.watchlist'),
+                            '2months' => get_string('filterby.2months', 'blocktype.watchlist'),
+                            'quarter' => get_string('filterby.quarter', 'blocktype.watchlist'),
+                            'half' => get_string('filterby.half', 'blocktype.watchlist'),
+                            'year' => get_string('filterby.year', 'blocktype.watchlist'),
+                            'login' => get_string('filterby.login', 'blocktype.watchlist'),
+                        ),
+                        'defaultvalue' => isset($configdata['period']) ? $configdata['period'] : 'login',
+                    ),
+                    'orderby' => array(
+                        'type'        => 'select',
+                        'title'       => get_string('orderby', 'blocktype.watchlist'),
+                        'description' => get_string('orderbydesc', 'blocktype.watchlist'),
+                        'options' => array(
+                            'activity' => get_string('orderby.activity', 'blocktype.watchlist'),
+                            'owner' => get_string('orderby.owner', 'blocktype.watchlist'),
+                        ),
+                        'defaultvalue' => isset($configdata['orderby']) ? $configdata['orderby'] : 'activity',
+                    ),
+                ),
+            ),
+            'count' => array(
                 'type'          => 'text',
                 'title'         => get_string('itemstoshow', 'blocktype.watchlist'),
                 'description'   => get_string('betweenxandy', 'mahara', 1, 100),
@@ -142,12 +250,26 @@ class PluginBlocktypeWatchlist extends MaharaCoreBlocktype {
         );
     }
 
+    public static function instance_config_save($values, BlockInstance $instance) {
+        $validwatchlistoptions = array('title', 'mode', 'count', 'retractable');
+
+        if ($values['mode'] == 'watchlist') {
+            foreach ($values as $key => $value) {
+                if (!in_array($key, $validwatchlistoptions)) {
+                    unset($values[$key]);
+                }
+            }
+        }
+
+        return $values;
+    }
+
     public static function default_copy_type() {
         return 'shallow';
     }
 
     /**
-     * watchlist only makes sense for personal views
+     * Watchlist only makes sense for personal views
      */
     public static function allowed_in_view(View $view) {
         return $view->get('owner') != null;
@@ -165,13 +287,109 @@ class PluginBlocktypeWatchlist extends MaharaCoreBlocktype {
         return get_string('title', 'blocktype.watchlist');
     }
 
-    /**
-     * Shouldn't be linked to any artefacts via the view_artefacts table.
-     *
-     * @param BlockInstance $instance
-     * @return multitype:
+    public static function filter_views_shared_to_user($viewdata, $options) {
+        global $USER;
+
+        $now = date("Y-m-d H:i:s");
+        switch ($options->period) {
+            case 'week':
+                $then = date("Y-m-d H:i:s", strtotime("-7 days"));
+                break;
+            case 'month':
+                $then = date("Y-m-d H:i:s", strtotime("-31 days"));
+                break;
+            case '2months':
+                $then = date("Y-m-d H:i:s", strtotime("-62 days"));
+                break;
+            case 'quarter':
+                $then = date("Y-m-d H:i:s", strtotime("-93 days"));
+                break;
+            case 'half':
+                $then = date("Y-m-d H:i:s", strtotime("-183 days"));
+                break;
+            case 'year':
+                $then = date("Y-m-d H:i:s", strtotime("-366 days"));
+                break;
+            case 'login':
+            default:
+                $then = db_format_timestamp($USER->get('lastlogin'));
+        }
+        if (empty($then)) {
+            // we are masquerading as a user that has never logged in so set value to yesterday
+            $then = date("Y-m-d H:i:s", strtotime("-1 days"));
+        }
+
+        $filterbydata = array();
+        foreach ($viewdata as $v) {
+            if ($v['mtime'] < $now && $v['mtime'] > $then) {
+                $filterbydata[] = $v;
+            }
+        }
+
+        $options->now = $now;
+        $options->then = $then;
+
+        if (isset($then) && !empty($then) && $options->orderby == 'owner') {
+            list($viewdata, $count) = self::filter_views_by_owner($filterbydata, $options);
+        }
+
+        if (isset($then) && !empty($then) && $options->orderby == 'activity') {
+            list($viewdata, $count) = self::filter_views_by_activity($filterbydata, $options);
+        }
+
+        return array($viewdata, $count);
+    }
+
+    /*
+     *  Filter and group pages by owner, then sort owners alphabetically.
      */
-    public static function get_artefacts(BlockInstance $instance) {
-        return array();
+    private static function filter_views_by_owner($viewdata, $options) {
+        $views = array();
+
+        // sort alphabetically by firstname and lastname
+        function compare_fullname($a, $b) {
+            if (!empty($a['owner']) && !empty($b['owner'])) {
+                // sort by owner last name
+                $retval = strnatcmp(no_accents($a['user']->lastname), no_accents($b['user']->lastname));
+                // if last names are identical, sort by first name
+                if (!$retval) {
+                    $retval = strnatcmp(no_accents($a['user']->firstname), no_accents($b['user']->firstname));
+                    return $retval;
+                }
+            }
+        }
+
+        if (count($viewdata) > 1) {
+            usort($viewdata, __NAMESPACE__ . '\compare_fullname');
+        }
+        $count = 0;
+        foreach ($viewdata as $v) {
+            if (!empty($v['owner'])) {
+                $key = $v['user']->username;
+                if ($v['mtime'] < $options->then) {
+                    $v['mtime'] = null;
+                }
+                $views[$key][] = $v;
+                $count++;
+            }
+        }
+
+        return array($views, $count);
     }
+
+    /*
+     *  Filter pages by reverse chronological order
+     *  based on mtime (when page was last updated)
+     */
+    private static function filter_views_by_activity($viewdata, $options) {
+        $views = array();
+        foreach ($viewdata as $v) {
+            if ($v['mtime'] < $options->then) {
+                $v['mtime'] = null;
+            }
+            $views[] = $v;
+        }
+        return array($views, count($views));
+    }
+
 }

htdocs/blocktype/watchlist/version.php

@@ -4,6 +4,7 @@
  * @package    mahara
  * @subpackage blocktype-watchlist
  * @author     Catalyst IT Ltd
+ * @author     Gregor Anelj <gregor.anzelj@gmail.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
  * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
  *
@@ -12,5 +13,5 @@
 defined('INTERNAL') || die();
 
 $config = new StdClass;
-$config->version = 2011090701;
-$config->release = '1.0.1';
+$config->version = 2016061400;
+$config->release = '1.1.0';

htdocs/lib/mahara.php

@@ -4915,3 +4915,26 @@ function clear_all_caches() {
 
     return $result;
 }
+
+/*
+ * Replaces all accented characters with un-accented counterparts.
+ *
+ * See: http://stackoverflow.com/questions/3371697/replacing-accented-characters-php
+ */
+function no_accents($str) {
+    $accents = array(
+        'Š'=>'S', 'š'=>'s', 'Ž'=>'Z', 'ž'=>'z', 'À'=>'A', 'Á'=>'A', 'Â'=>'A',
+        'Ã'=>'A', 'Ä'=>'A', 'Å'=>'A', 'Æ'=>'A', 'Ç'=>'C', 'È'=>'E', 'É'=>'E',
+        'Ê'=>'E', 'Ë'=>'E', 'Ì'=>'I', 'Í'=>'I', 'Î'=>'I', 'Ï'=>'I', 'Ñ'=>'N',
+        'Ò'=>'O', 'Ó'=>'O', 'Ô'=>'O', 'Õ'=>'O', 'Ö'=>'O', 'Ø'=>'O', 'Ù'=>'U',
+        'Ú'=>'U', 'Û'=>'U', 'Ü'=>'U', 'Ý'=>'Y', 'Þ'=>'B', 'ß'=>'ss', 'à'=>'a',
+        'á'=>'a', 'â'=>'a', 'ã'=>'a', 'ä'=>'a', 'å'=>'a', 'æ'=>'a', 'ç'=>'c',
+        'è'=>'e', 'é'=>'e', 'ê'=>'e', 'ë'=>'e', 'ì'=>'i', 'í'=>'i', 'î'=>'i',
+        'ï'=>'i', 'ð'=>'o', 'ñ'=>'n', 'ò'=>'o', 'ó'=>'o', 'ô'=>'o', 'õ'=>'o',
+        'ö'=>'o', 'ø'=>'o', 'ù'=>'u', 'ú'=>'u', 'û'=>'u', 'ý'=>'y', 'þ'=>'b',
+        'ÿ'=>'y', 'ă'=>'a', 'Ă'=>'A', 'ș'=>'s', 'Ș'=>'S', 'ț'=>'t', 'Ț'=>'T',
+        'Ğ'=>'G', 'İ'=>'I', 'Ş'=>'S', 'ğ'=>'g', 'ı'=>'i', 'ş'=>'s', 'ü'=>'u',
+        'Č'=>'C', 'č'=>'c', 'Ć'=>'c', 'ć'=>'c', 'Đ'=>'dz', 'đ'=>'dz'
+    );
+    return strtr($str, $accents);
+}

htdocs/lib/searchlib.php

@@ -1074,7 +1074,7 @@ function get_search_plugins() {
  *               ),
  *           );
  */
-function search_friend($filter, $limit, $offset) {
+function search_friend($filter, $limit = null, $offset = 0) {
     global $USER;
     $userid = $USER->get('id');
 
@@ -1109,12 +1109,17 @@ function search_friend($filter, $limit, $offset) {
         array_push($sql, 'SELECT requester AS id, 1 AS status FROM {usr_friend_request} WHERE "owner" = ?
         ');
     }
-
-    $data = get_column_sql('SELECT f.id FROM (' . join('UNION ', $sql) . ') f
-        JOIN {usr} u ON (f.id = u.id AND u.deleted = 0)
-        ORDER BY status, firstname, lastname, u.id
-        LIMIT ?
-        OFFSET ?', array_merge(array_pad($values=array(), count($sql), $userid), array($limit, $offset)));
+    $sqlstr = 'SELECT f.id FROM (' . join('UNION ', $sql) . ') f
+            JOIN {usr} u ON (f.id = u.id AND u.deleted = 0)
+            ORDER BY status, firstname, lastname, u.id';
+    if ($limit) {
+        $data = get_column_sql($sqlstr . ' LIMIT ? OFFSET ?',
+            array_merge(array_pad($values=array(), count($sql), $userid), array($limit, $offset)));
+    }
+    else {
+        $data = get_column_sql($sqlstr,
+            array_merge(array_pad($values=array(), count($sql), $userid)));
+    }
 
     foreach ($data as &$result) {
         $result = array('id' => $result);

htdocs/lib/view.php

@@ -4190,7 +4190,21 @@ class View {
         $where .= join(',', array_map('db_quote', $types)) . ')';
 
         if ($ownedby) {
-            $where .= ' AND v.' . self::owner_sql($ownedby);
+            if (is_array($ownedby)) {
+                // we have an array of owner objects
+                $ownerwherestr = '(';
+                foreach ($ownedby as $key => $ownedbyobject) {
+                    if ($key !== 0) {
+                        $ownerwherestr .= ' OR ';
+                    }
+                    $ownerwherestr .= 'v.' . self::owner_sql($ownedbyobject);
+                }
+                $ownerwherestr .= ')';
+                $where .= ' AND ' . $ownerwherestr;
+            }
+            else {
+                $where .= ' AND v.' . self::owner_sql($ownedby);
+            }
         }
 
         if ($copyableby) {

htdocs/theme/raw/plugintype/blocktype/watchlist/templates/followeractivitypaginator.tpl

+        {foreach $views as item=view}
+            <li class="list-group-item">
+                <h4 class="title list-group-item-heading">
+                    <a href="{$view.fullurl}">
+                    {$view.title}
+                    </a>
+                </h4>
+                {if $view.sharedby}
+                    <div class="groupuserdate text-small">
+                    {if $view.group && $loggedin}
+                    <a class="inner-link" href="{group_homepage_url($view.groupdata)}">{$view.sharedby}</a>
+                    {elseif $view.owner && $loggedin}
+                        {if $view.anonymous}
+                            {if $view.staff_or_admin}
+                                {assign var='realauthor' value=$view.sharedby}
+                                {assign var='realauthorlink' value=profile_url($view.user)}
+                            {/if}
+                            {assign var='author' value=get_string('anonymoususer')}
+                            {include file=author.tpl}
+                        {else}
+                            <a class="inner-link" href="{profile_url($view.user)}">{$view.sharedby}</a>
+                        {/if}
+                    {else}
+                        {$view.sharedby}
+                    {/if}
+                    <span class="postedon text-midtone">
+                    - {str tag=Updated} {$view.mtime|strtotime|format_date:'strftimedatetime'}
+                    </span>
+                    </div>
+                {/if}
+            </li>
+        {/foreach}

htdocs/theme/raw/plugintype/blocktype/watchlist/templates/followerownerpaginator.tpl

+    {foreach $views as item=owner}
+        <li class="list-group-item">
+            <h4 class="title list-group-item-heading">
+                <span class="icon icon-user"></span>
+                <b>{$owner[0].sharedby}</b>
+            </h4>
+        </li>
+        {foreach $owner as item=view}
+            <li class="list-group-item">
+                <a href="{$view.fullurl}" class=" outer-link watchlist-showview">
+                    <span class="sr-only">{$view.title}</span>
+                </a>
+                <h4 class="title list-group-item-heading">
+                    {$view.title}
+                </h4>
+                {if $view.sharedby}
+                    <div class="groupuserdate text-small">
+                    {if $view.group && $loggedin}
+                    <a class="inner-link" href="{group_homepage_url($view.groupdata)}">{$view.sharedby}</a>
+                    {elseif $view.owner && $loggedin}
+                        {if $view.anonymous}
+                            {if $view.staff_or_admin}
+                                {assign var='realauthor' value=$view.sharedby}
+                                {assign var='realauthorlink' value=profile_url($view.user)}
+                            {/if}
+                            {assign var='author' value=get_string('anonymoususer')}
+                            {include file=author.tpl}
+                        {else}
+                            <a class="inner-link" href="{profile_url($view.user)}">{$view.sharedby}</a>
+                        {/if}
+                    {else}
+                        {$view.sharedby}
+                    {/if}
+                    <span class="postedon text-midtone">
+                    - {str tag=Updated} {$view.mtime|strtotime|format_date:'strftimedatetime'}
+                    </span>
+                    </div>
+                {/if}
+            </li>
+        {/foreach}
+    {/foreach}