]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Favorite/classes/Fave.php
More Favorite pluginification (favecount, cache, menus(favecount, cache, menus))
[quix0rs-gnu-social.git] / plugins / Favorite / classes / Fave.php
1 <?php
2 /**
3  * Table Definition for fave
4  */
5 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
6
7 class Fave extends Managed_DataObject
8 {
9     ###START_AUTOCODE
10     /* the code below is auto generated do not remove the above tag */
11
12     public $__table = 'fave';                            // table name
13     public $notice_id;                       // int(4)  primary_key not_null
14     public $user_id;                         // int(4)  primary_key not_null
15     public $uri;                             // varchar(255)
16     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
17
18     /* the code above is auto generated do not remove the tag below */
19     ###END_AUTOCODE
20
21     public static function schemaDef()
22     {
23         return array(
24             'fields' => array(
25                 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the favorite'),
26                 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who likes this notice'),
27                 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
28                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
29             ),
30             'primary key' => array('notice_id', 'user_id'),
31             'unique keys' => array(
32                 'fave_uri_key' => array('uri'),
33             ),
34             'foreign keys' => array(
35                 'fave_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
36                 'fave_user_id_fkey' => array('profile', array('user_id' => 'id')), // note: formerly referenced notice.id, but we can now record remote users' favorites
37             ),
38             'indexes' => array(
39                 'fave_notice_id_idx' => array('notice_id'),
40                 'fave_user_id_idx' => array('user_id', 'modified'),
41                 'fave_modified_idx' => array('modified'),
42             ),
43         );
44     }
45
46     /**
47      * Save a favorite record.
48      * @fixme post-author notification should be moved here
49      *
50      * @param Profile $profile the local or remote user who likes
51      * @param Notice $notice the notice that is liked
52      * @return mixed false on failure, or Fave record on success
53      */
54     static function addNew(Profile $profile, Notice $notice) {
55
56         $fave = null;
57
58         if (Event::handle('StartFavorNotice', array($profile, $notice, &$fave))) {
59
60             $fave = new Fave();
61
62             $fave->user_id   = $profile->id;
63             $fave->notice_id = $notice->id;
64             $fave->modified  = common_sql_now();
65             $fave->uri       = self::newURI($fave->user_id,
66                                             $fave->notice_id,
67                                             $fave->modified);
68             if (!$fave->insert()) {
69                 common_log_db_error($fave, 'INSERT', __FILE__);
70                 return false;
71             }
72             self::blow('fave:list-ids:notice_id:%d', $fave->notice_id);
73             self::blow('popular');
74
75             Event::handle('EndFavorNotice', array($profile, $notice));
76         }
77
78         return $fave;
79     }
80
81     function delete($useWhere=false)
82     {
83         $profile = Profile::getKV('id', $this->user_id);
84         $notice  = Notice::getKV('id', $this->notice_id);
85
86         $result = null;
87
88         if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
89
90             $result = parent::delete($useWhere);
91             self::blow('fave:list-ids:notice_id:%d', $this->notice_id);
92             self::blow('popular');
93
94             if ($result) {
95                 Event::handle('EndDisfavorNotice', array($profile, $notice));
96             }
97         }
98
99         return $result;
100     }
101
102     function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
103     {
104         $stream = new FaveNoticeStream($user_id, $own);
105
106         return $stream->getNotices($offset, $limit, $since_id, $max_id);
107     }
108
109     function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
110     {
111         $stream = new FaveNoticeStream($user_id, $own);
112
113         return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
114     }
115
116     function asActivity()
117     {
118         $notice = Notice::getKV('id', $this->notice_id);
119
120         if (!$notice) {
121             throw new Exception("Fave for non-existent notice: " . $this->notice_id);
122         }
123
124         $profile = Profile::getKV('id', $this->user_id);
125
126         if (!$profile) {
127             throw new Exception("Fave by non-existent profile: " . $this->user_id);
128         }
129
130         $act = new Activity();
131
132         $act->verb = ActivityVerb::FAVORITE;
133
134         // FIXME: rationalize this with URL below
135
136         $act->id   = $this->getURI();
137
138         $act->time    = strtotime($this->modified);
139         // TRANS: Activity title when marking a notice as favorite.
140         $act->title   = _("Favor");
141         // TRANS: Ntofication given when a user marks a notice as favorite.
142         // TRANS: %1$s is a user nickname or full name, %2$s is a notice URI.
143         $act->content = sprintf(_('%1$s marked notice %2$s as a favorite.'),
144                                $profile->getBestName(),
145                                $notice->getUrl());
146
147         $act->actor     = ActivityObject::fromProfile($profile);
148         $act->objects[] = ActivityObject::fromNotice($notice);
149
150         $url = common_local_url('AtomPubShowFavorite',
151                                           array('profile' => $this->user_id,
152                                                 'notice'  => $this->notice_id));
153
154         $act->selfLink = $url;
155         $act->editLink = $url;
156
157         return $act;
158     }
159
160     static function existsForProfile($notice, Profile $scoped) {
161         $fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
162
163         return ($fave instanceof Fave);
164     }
165
166     /**
167      * Fetch a stream of favorites by profile
168      *
169      * @param integer $profileId Profile that faved
170      * @param integer $offset    Offset from last
171      * @param integer $limit     Number to get
172      *
173      * @return mixed stream of faves, use fetch() to iterate
174      *
175      * @todo Cache results
176      * @todo integrate with Fave::stream()
177      */
178
179     static function byProfile($profileId, $offset, $limit)
180     {
181         $fav = new Fave();
182
183         $fav->user_id = $profileId;
184
185         $fav->orderBy('modified DESC');
186
187         $fav->limit($offset, $limit);
188
189         $fav->find();
190
191         return $fav;
192     }
193
194     static function countByProfile(Profile $profile)
195     {
196         $c = Cache::instance();
197         if (!empty($c)) {
198             $cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
199             if (is_integer($cnt)) {
200                 return $cnt;
201             }
202         }
203
204         $faves = new Fave();
205         $faves->user_id = $profile->id;
206         $cnt = (int) $faves->count('notice_id');
207
208         if (!empty($c)) {
209             $c->set(Cache::key('fave:count_by_profile:'.$profile->id), $cnt);
210         }
211
212         return $cnt;
213     }
214
215     function getURI()
216     {
217         if (!empty($this->uri)) {
218             return $this->uri;
219         } else {
220             return self::newURI($this->user_id, $this->notice_id, $this->modified);
221         }
222     }
223
224     static function newURI($profile_id, $notice_id, $modified)
225     {
226         return TagURI::mint('favor:%d:%d:%s',
227                             $profile_id,
228                             $notice_id,
229                             common_date_iso8601($modified));
230     }
231
232
233     static protected $_faves = array();
234
235     /**
236      * All faves of this notice
237      *
238      * @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
239      *
240      * @return array Array of Fave objects
241      */
242     static public function byNotice($notice)
243     {
244         if (!isset(self::$_faves[$notice->id])) {
245             self::fillFaves(array($notice->id));
246         }
247         return self::$_faves[$notice->id];
248     }
249
250     static public function fillFaves(array $notice_ids)
251     {
252         $faveMap = Fave::listGet('notice_id', $notice_ids);
253         self::$_faves = array_replace(self::$_faves, $faveMap);
254     }
255
256     static public function blowCacheForProfileId($profile_id)
257     {
258         $cache = Cache::instance();
259         if ($cache) {
260             // Faves don't happen chronologically, so we need to blow
261             // ;last cache, too
262             $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id));
263             $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id.';last'));
264             $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id));
265             $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id.';last'));
266             $cache->delete(Cache::key('fave:count_by_profile:'.$profile_id));
267         }
268     }
269 }