classes/Profile_prefs.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Data class for Profile preferences
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Data
  23  * @package   GNUsocial
  24  * @author    Mikael Nordfeldth <mmn@hethane.se>
  25  * @copyright 2013 Free Software Foundation, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://www.gnu.org/software/social/
  28  */
  29
  30 class Profile_prefs extends Managed_DataObject
  31 {
  32     public $__table = 'profile_prefs';       // table name
  33     public $profile_id;                      // int(4)  primary_key not_null
  34     public $namespace;                       // varchar(191)  not_null
  35     public $topic;                           // varchar(191)  not_null
  36     public $data;                            // text
  37     public $created;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
  38     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  39
  40     public static function schemaDef()
  41     {
  42         return array(
  43             'fields' => array(
  44                 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'user'),
  45                 'namespace' => array('type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'namespace, like pluginname or category'),
  46                 'topic' => array('type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'preference key, i.e. description, age...'),
  47                 'data' => array('type' => 'blob', 'description' => 'topic data, may be anything'),
  48                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  49                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  50             ),
  51             'primary key' => array('profile_id', 'namespace', 'topic'),
  52             'foreign keys' => array(
  53                 'profile_prefs_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
  54             ),
  55             'indexes' => array(
  56                 'profile_prefs_profile_id_idx' => array('profile_id'),
  57             ),
  58         );
  59     }
  60
  61     static function getNamespacePrefs(Profile $profile, $namespace, array $topic=array())
  62     {
  63         if (empty($topic)) {
  64             $prefs = new Profile_prefs();
  65             $prefs->profile_id = $profile->getID();
  66             $prefs->namespace  = $namespace;
  67             $prefs->find();
  68         } else {
  69             $prefs = self::pivotGet('profile_id', $profile->getID(), array('namespace'=>$namespace, 'topic'=>$topic));
  70         }
  71
  72         if (empty($prefs->N)) {
  73             throw new NoResultException($prefs);
  74         }
  75
  76         return $prefs;
  77     }
  78
  79     static function getNamespace(Profile $profile, $namespace, array $topic=array())
  80     {
  81         $prefs = self::getNamespacePrefs($profile, $namespace, $topic);
  82         return $prefs->fetchAll();
  83     }
  84
  85     static function getAll(Profile $profile)
  86     {
  87         try {
  88             $prefs = self::listFind('profile_id', array($profile->getID()));
  89         } catch (NoResultException $e) {
  90             return array();
  91         }
  92
  93         $list = array();
  94         while ($prefs->fetch()) {
  95             if (!isset($list[$prefs->namespace])) {
  96                 $list[$prefs->namespace] = array();
  97             }
  98             $list[$prefs->namespace][$prefs->topic] = $prefs->data;
  99         }
 100         return $list;
 101     }
 102
 103     static function getTopic(Profile $profile, $namespace, $topic) {
 104         return Profile_prefs::getByPK(array('profile_id' => $profile->getID(),
 105                                             'namespace'  => $namespace,
 106                                             'topic'      => $topic));
 107     }
 108
 109     static function getData(Profile $profile, $namespace, $topic, $def=null) {
 110         try {
 111             $pref = self::getTopic($profile, $namespace, $topic);
 112         } catch (NoResultException $e) {
 113             if ($def === null) {
 114                 // If no default value was set, continue the exception.
 115                 throw $e;
 116             }
 117             // If there was a default value, return that.
 118             return $def;
 119         }
 120         return $pref->data;
 121     }
 122
 123     static function getConfigData(Profile $profile, $namespace, $topic) {
 124         try {
 125             $data = self::getData($profile, $namespace, $topic);
 126         } catch (NoResultException $e) {
 127             $data = common_config($namespace, $topic);
 128         }
 129         return $data;
 130     }
 131
 132     /*
 133      * Sets a profile preference based on Profile, namespace and topic
 134      *
 135      * @param  Profile $profile   Which profile this is for
 136      * @param  string  $namespace Under which namespace (pluginname etc.)
 137      * @param  string  $topic     Preference name (think key in key-val store)
 138      * @param  string  $data      Data to be put into preference storage, null means delete
 139      *
 140      * @return true if changes are made, false if no action taken
 141      * @throws ServerException if preference could not be saved
 142      */
 143     static function setData(Profile $profile, $namespace, $topic, $data=null) {
 144         try {
 145             $pref = self::getTopic($profile, $namespace, $topic);
 146             if (is_null($data)) {
 147                 $pref->delete();
 148             } else {
 149                 $orig = clone($pref);
 150                 $pref->data = $data;
 151                 $pref->update($orig);
 152             }
 153             return true;
 154         } catch (NoResultException $e) {
 155             if (is_null($data)) {
 156                 return false; // No action taken
 157             }
 158         }
 159
 160         $pref = new Profile_prefs();
 161         $pref->profile_id = $profile->getID();
 162         $pref->namespace  = $namespace;
 163         $pref->topic      = $topic;
 164         $pref->data       = $data;
 165         $pref->created    = common_sql_now();
 166
 167         if ($pref->insert() === false) {
 168             throw new ServerException('Could not save profile preference.');
 169         }
 170         return true;
 171     }
 172 }