Notice_prefs.php 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <?php
  2. /**
  3. * GNU social
  4. *
  5. * Data class for Notice 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. class Notice_prefs extends Managed_DataObject
  30. {
  31. public $__table = 'notice_prefs'; // table name
  32. public $notice_id; // int(4) primary_key not_null
  33. public $namespace; // varchar(191) not_null
  34. public $topic; // varchar(191) not_null
  35. public $data; // text
  36. public $created; // datetime not_null default_0000-00-00%2000%3A00%3A00
  37. public $modified; // timestamp not_null default_CURRENT_TIMESTAMP
  38. public static function schemaDef()
  39. {
  40. return array(
  41. 'fields' => array(
  42. 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'user'),
  43. 'namespace' => array('type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'namespace, like pluginname or category'),
  44. 'topic' => array('type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'preference key, i.e. description, age...'),
  45. 'data' => array('type' => 'blob', 'description' => 'topic data, may be anything'),
  46. 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  47. 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  48. ),
  49. 'primary key' => array('notice_id', 'namespace', 'topic'),
  50. 'foreign keys' => array(
  51. 'notice_prefs_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
  52. ),
  53. 'indexes' => array(
  54. 'notice_prefs_notice_id_idx' => array('notice_id'),
  55. ),
  56. );
  57. }
  58. static function getNamespacePrefs(Notice $notice, $namespace, array $topic=array())
  59. {
  60. if (empty($topic)) {
  61. $prefs = new Notice_prefs();
  62. $prefs->notice_id = $notice->getID();
  63. $prefs->namespace = $namespace;
  64. $prefs->find();
  65. } else {
  66. $prefs = self::pivotGet('notice_id', $notice->getID(), array('namespace'=>$namespace, 'topic'=>$topic));
  67. }
  68. if (empty($prefs->N)) {
  69. throw new NoResultException($prefs);
  70. }
  71. return $prefs;
  72. }
  73. static function getNamespace(Notice $notice, $namespace, array $topic=array())
  74. {
  75. $prefs = self::getNamespacePrefs($notice, $namespace, $topic);
  76. return $prefs->fetchAll();
  77. }
  78. static function getAll(Notice $notice)
  79. {
  80. try {
  81. $prefs = self::listFind('notice_id', array($notice->getID()));
  82. } catch (NoResultException $e) {
  83. return array();
  84. }
  85. $list = array();
  86. while ($prefs->fetch()) {
  87. if (!isset($list[$prefs->namespace])) {
  88. $list[$prefs->namespace] = array();
  89. }
  90. $list[$prefs->namespace][$prefs->topic] = $prefs->data;
  91. }
  92. return $list;
  93. }
  94. static function getTopic(Notice $notice, $namespace, $topic) {
  95. return self::getByPK(array('notice_id' => $notice->getID(),
  96. 'namespace' => $namespace,
  97. 'topic' => $topic));
  98. }
  99. static function getData(Notice $notice, $namespace, $topic, $def=null) {
  100. try {
  101. $pref = self::getTopic($notice, $namespace, $topic);
  102. } catch (NoResultException $e) {
  103. if ($def === null) {
  104. // If no default value was set, continue the exception.
  105. throw $e;
  106. }
  107. // If there was a default value, return that.
  108. return $def;
  109. }
  110. return $pref->data;
  111. }
  112. static function getConfigData(Notice $notice, $namespace, $topic) {
  113. try {
  114. $data = self::getData($notice, $namespace, $topic);
  115. } catch (NoResultException $e) {
  116. $data = common_config($namespace, $topic);
  117. }
  118. return $data;
  119. }
  120. /*
  121. * Sets a notice preference based on Notice, namespace and topic
  122. *
  123. * @param Notice $notice Which notice this is for
  124. * @param string $namespace Under which namespace (pluginname etc.)
  125. * @param string $topic Preference name (think key in key-val store)
  126. * @param string $data Data to be put into preference storage, null means delete
  127. *
  128. * @return true if changes are made, false if no action taken
  129. * @throws ServerException if preference could not be saved
  130. */
  131. static function setData(Notice $notice, $namespace, $topic, $data=null) {
  132. try {
  133. $pref = self::getTopic($notice, $namespace, $topic);
  134. if (is_null($data)) {
  135. $pref->delete();
  136. } else {
  137. $orig = clone($pref);
  138. $pref->data = $data;
  139. $pref->update($orig);
  140. }
  141. return true;
  142. } catch (NoResultException $e) {
  143. if (is_null($data)) {
  144. return false; // No action taken
  145. }
  146. }
  147. $pref = new Notice_prefs();
  148. $pref->notice_id = $notice->getID();
  149. $pref->namespace = $namespace;
  150. $pref->topic = $topic;
  151. $pref->data = $data;
  152. $pref->created = common_sql_now();
  153. if ($pref->insert() === false) {
  154. throw new ServerException('Could not save notice preference.');
  155. }
  156. return true;
  157. }
  158. }