summaryrefslogtreecommitdiff
path: root/actions/twitapistatuses.php
blob: 53c5f13264e759e08437d35541a2bdf4dd92cd9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
<?php
/*
 * Laconica - a distributed open-source microblogging tool
 * Copyright (C) 2008, Controlez-Vous, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

if (!defined('LACONICA')) { exit(1); }

require_once(INSTALLDIR.'/lib/twitterapi.php');

/* XXX: Please don't freak out about all the ugly comments in this file.
 * They are mostly in here for reference while I work on the
 * API. I'll fix things up later to make them look better later. -- Zach
 */
class TwitapistatusesAction extends TwitterapiAction {

	function is_readonly() {

		static $write_methods = array(	'update',
										'destroy');

		$cmdtext = explode('.', $this->arg('method'));

		if (in_array($cmdtext[0], $write_methods)) {
			return false;
		}

		return true;
	}

	function public_timeline($args, $apidata) {
		parent::handle($args);

		$sitename = common_config('site', 'name');
		$siteserver = common_config('site', 'server');
		$title = sprintf(_("%s public timeline"), $sitename);
		$id = "tag:$siteserver:Statuses";
		$link = common_root_url();
		$subtitle = sprintf(_("%s updates from everyone!"), $sitename);

		// Number of public statuses to return by default -- Twitter sends 20
		$MAX_PUBSTATUSES = 20;

		// FIXME: To really live up to the spec we need to build a list
		// of notices by users who have custom avatars, so fix this SQL -- Zach

    	$page = $this->arg('page');
    	$since_id = $this->arg('since_id');
    	$before_id = $this->arg('before_id');

		// NOTE: page, since_id, and before_id are extensions to Twitter API -- TB
        if (!$page) {
            $page = 1;
        }
        if (!$since_id) {
            $since_id = 0;
        }
        if (!$before_id) {
            $before_id = 0;
        }

		$notice = Notice::publicStream((($page-1)*$MAX_PUBSTATUSES), $MAX_PUBSTATUSES, $since_id, $before_id);

		if ($notice) {

			switch($apidata['content-type']) {
				case 'xml':
					$this->show_xml_timeline($notice);
					break;
				case 'rss':
					$this->show_rss_timeline($notice, $title, $link, $subtitle);
					break;
				case 'atom':
					$this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
					break;
				case 'json':
					$this->show_json_timeline($notice);
					break;
				default:
					common_user_error(_('API method not found!'), $code = 404);
					break;
			}

		} else {
			common_server_error(_('Couldn\'t find any statuses.'), $code = 503);
		}

	}

	/*
	Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
	This is the equivalent of /home on the Web.

	URL: http://server/api/statuses/friends_timeline.format

	Parameters:

	    * since.  Optional.  Narrows the returned results to just those statuses created after the specified
			HTTP-formatted date.  The same behavior is available by setting an If-Modified-Since header in
			your HTTP request.
			Ex: http://server/api/statuses/friends_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
	    * since_id.  Optional.  Returns only statuses with an ID greater than (that is, more recent than)
			the specified ID.  Ex: http://server/api/statuses/friends_timeline.xml?since_id=12345
	    * count.  Optional.  Specifies the number of statuses to retrieve. May not be greater than 200.
	  		Ex: http://server/api/statuses/friends_timeline.xml?count=5
	    * page. Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3

	Formats: xml, json, rss, atom
	*/
	function friends_timeline($args, $apidata) {
		parent::handle($args);

		$since = $this->arg('since');
		$since_id = $this->arg('since_id');
		$count = $this->arg('count');
    	$page = $this->arg('page');
    	$before_id = $this->arg('before_id');

        if (!$page) {
            $page = 1;
        }

		if (!$count) {
			$count = 20;
		}

        if (!$since_id) {
            $since_id = 0;
        }

		// NOTE: before_id is an extensions to Twitter API -- TB
        if (!$before_id) {
            $before_id = 0;
        }

		$user = $this->get_user($id, $apidata);
		$profile = $user->getProfile();

		$sitename = common_config('site', 'name');
		$siteserver = common_config('site', 'server');

		$title = sprintf(_("%s and friends"), $user->nickname);
		$id = "tag:$siteserver:friends:".$user->id;
		$link = common_local_url('all', array('nickname' => $user->nickname));
		$subtitle = sprintf(_('Updates from %1$s and friends on %2$s!'), $user->nickname, $sitename);

		$notice = $user->noticesWithFriends(($page-1)*20, $count, $since_id, $before_id);

		switch($apidata['content-type']) {
		 case 'xml':
			$this->show_xml_timeline($notice);
			break;
		 case 'rss':
			$this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
			break;
		 case 'atom':
			$this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
			break;
		 case 'json':
			$this->show_json_timeline($notice);
			break;
		 default:
			common_user_error(_('API method not found!'), $code = 404);
		}

	}

	/*
		Returns the 20 most recent statuses posted from the authenticating user. It's also possible to
        request another user's timeline via the id parameter below. This is the equivalent of the Web
        /archive page for your own user, or the profile page for a third party.

		URL: http://server/api/statuses/user_timeline.format

		Formats: xml, json, rss, atom

		Parameters:

		    * id. Optional. Specifies the ID or screen name of the user for whom to return the
            friends_timeline. Ex: http://server/api/statuses/user_timeline/12345.xml or
            http://server/api/statuses/user_timeline/bob.json.
			* count. Optional. Specifies the number of
            statuses to retrieve. May not be greater than 200. Ex:
            http://server/api/statuses/user_timeline.xml?count=5
			* since. Optional. Narrows the returned
            results to just those statuses created after the specified HTTP-formatted date. The same
            behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
            http://server/api/statuses/user_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
			* since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
            the specified ID. Ex: http://server/api/statuses/user_timeline.xml?since_id=12345 * page.
            Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3
	*/
	function user_timeline($args, $apidata) {
		parent::handle($args);

		$user = null;

		// function was called with an argument /statuses/user_timeline/api_arg.format
		if (isset($apidata['api_arg'])) {

			if (is_numeric($apidata['api_arg'])) {
				$user = User::staticGet($apidata['api_arg']);
			} else {
				$nickname = common_canonical_nickname($apidata['api_arg']);
				$user = User::staticGet('nickname', $nickname);
			}
		} else {

			// if no user was specified, then we'll use the authenticated user
			$user = $apidata['user'];
		}

		if (!$user) {
			// Set the user to be the auth user if asked-for can't be found
			// honestly! This is what Twitter does, I swear --Zach
			$user = $apidata['user'];
		}

		$profile = $user->getProfile();

		if (!$profile) {
			common_server_error(_('User has no profile.'));
			return;
		}

		$count = $this->arg('count');
		$since = $this->arg('since');
    	$since_id = $this->arg('since_id');
		$page = $this->arg('page');
    	$before_id = $this->arg('before_id');

		if (!$page) {
			$page = 1;
		}

		if (!$count) {
			$count = 20;
		}

        if (!$since_id) {
            $since_id = 0;
        }

		// NOTE: before_id is an extensions to Twitter API -- TB
        if (!$before_id) {
            $before_id = 0;
        }

		$sitename = common_config('site', 'name');
		$siteserver = common_config('site', 'server');

		$title = sprintf(_("%s timeline"), $user->nickname);
		$id = "tag:$siteserver:user:".$user->id;
		$link = common_local_url('showstream', array('nickname' => $user->nickname));
		$subtitle = sprintf(_('Updates from %1$s on %2$s!'), $user->nickname, $sitename);

		# XXX: since

		$notice = $user->getNotices((($page-1)*20), $count, $since_id, $before_id);

		switch($apidata['content-type']) {
		 case 'xml':
			$this->show_xml_timeline($notice);
			break;
		 case 'rss':
			$this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
			break;
		 case 'atom':
			$this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
			break;
		 case 'json':
			$this->show_json_timeline($notice);
			break;
		 default:
			common_user_error(_('API method not found!'), $code = 404);
		}

	}

	function update($args, $apidata) {

		parent::handle($args);

		if (!in_array($apidata['content-type'], array('xml', 'json'))) {
			common_user_error(_('API method not found!'), $code = 404);
			return;
		}

		if ($_SERVER['REQUEST_METHOD'] != 'POST') {
			$this->client_error(_('This method requires a POST.'), 400, $apidata['content-type']);
			return;
		}

		$user = $apidata['user'];
		$status = $this->trimmed('status');
		$source = $this->trimmed('source');
		$in_reply_to_status_id = intval($this->trimmed('in_reply_to_status_id'));

		if (!$source) {
			$source = 'api';
		}

		if (!$status) {

			// XXX: Note: In this case, Twitter simply returns '200 OK'
			// No error is given, but the status is not posted to the
			// user's timeline.  Seems bad.  Shouldn't we throw an
			// errror? -- Zach
			return;

		} else if (mb_strlen($status) > 140) {

			// XXX: Twitter truncates anything over 140, flags the status
		    // as "truncated."  Sending this error may screw up some clients
		    // that assume Twitter will truncate for them.  Should we just
		    // truncate too? -- Zach
			$this->client_error(_('That\'s too long. Max notice size is 140 chars.'), $code = 406, $apidata['content-type']);
			return;
		}

		// Check for commands
		$inter = new CommandInterpreter();
		$cmd = $inter->handle_command($user, $status);

		if ($cmd) {

			if ($this->supported($cmd)) {
				$cmd->execute(new Channel());
			}

			// cmd not supported?  Twitter just returns your latest status.
			// And, it returns your last status whether the cmd was successful
			// or not!
			$n = $user->getCurrentNotice();
			$apidata['api_arg'] = $n->id;
		} else {

			$reply_to = NULL;

			if ($in_reply_to_status_id) {

				// check whether notice actually exists
				$reply = Notice::staticGet($in_reply_to_status_id);

				if ($reply) {
					$reply_to = $in_reply_to_status_id;
				} else {
					$this->client_error(_('Not found'), $code = 404, $apidata['content-type']);
					return;
				}
			}

			$notice = Notice::saveNew($user->id, $status, $source, 1, $reply_to);

			if (is_string($notice)) {
				$this->server_error($notice);
				return;
			}

			common_broadcast_notice($notice);
			$apidata['api_arg'] = $notice->id;
		}

		$this->show($args, $apidata);
	}

	/*
		Returns the 20 most recent @replies (status updates prefixed with @username) for the authenticating user.
		URL: http://server/api/statuses/replies.format

		Formats: xml, json, rss, atom

 		Parameters:

 		* page. Optional. Retrieves the 20 next most recent replies. Ex: http://server/api/statuses/replies.xml?page=3
		* since. Optional. Narrows the returned results to just those replies created after the specified HTTP-formatted date. The
        same behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
        http://server/api/statuses/replies.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
		* since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) the specified
		ID. Ex: http://server/api/statuses/replies.xml?since_id=12345
	*/
	function replies($args, $apidata) {

		parent::handle($args);

		$since = $this->arg('since');

		$count = $this->arg('count');
		$page = $this->arg('page');
    	$since_id = $this->arg('since_id');
    	$before_id = $this->arg('before_id');

		$user = $apidata['user'];
		$profile = $user->getProfile();

		$sitename = common_config('site', 'name');
		$siteserver = common_config('site', 'server');

		$title = sprintf(_('%1$s / Updates replying to %2$s'), $sitename, $user->nickname);
		$id = "tag:$siteserver:replies:".$user->id;
		$link = common_local_url('replies', array('nickname' => $user->nickname));
		$subtitle = sprintf(_('%1$s updates that reply to updates from %2$s / %3$s.'), $sitename, $user->nickname, $profile->getBestName());

		if (!$page) {
			$page = 1;
		}

		if (!$count) {
			$count = 20;
		}

        if (!$since_id) {
            $since_id = 0;
        }

		// NOTE: before_id is an extensions to Twitter API -- TB
        if (!$before_id) {
            $before_id = 0;
        }
		$notice = $user->getReplies((($page-1)*20), $count, $since_id, $before_id);
		$notices = array();

		while ($notice->fetch()) {
			$notices[] = clone($notice);
		}

		switch($apidata['content-type']) {
		 case 'xml':
			$this->show_xml_timeline($notices);
			break;
		 case 'rss':
			$this->show_rss_timeline($notices, $title, $id, $link, $subtitle);
			break;
		 case 'atom':
			$this->show_atom_timeline($notices, $title, $id, $link, $subtitle);
			break;
		 case 'json':
			$this->show_json_timeline($notices);
			break;
		 default:
			common_user_error(_('API method not found!'), $code = 404);
		}

	}

	function show($args, $apidata) {
		parent::handle($args);

		if (!in_array($apidata['content-type'], array('xml', 'json'))) {
			common_user_error(_('API method not found!'), $code = 404);
			return;
		}

		$notice_id = $apidata['api_arg'];
		$notice = Notice::staticGet($notice_id);

		if ($notice) {
			if ($apidata['content-type'] == 'xml') {
				$this->show_single_xml_status($notice);
			} elseif ($apidata['content-type'] == 'json') {
				$this->show_single_json_status($notice);
			}
		} else {
			// XXX: Twitter just sets a 404 header and doens't bother to return an err msg
			$this->client_error(_('No status with that ID found.'), 404, $apidata['content-type']);
		}

	}


	/*
		Destroys the status specified by the required ID parameter. The authenticating user must be
        the author of the specified status.

		 URL: http://server/api/statuses/destroy/id.format

		 Formats: xml, json

		 Parameters:

		 * id. Required. The ID of the status to destroy. Ex:
        	http://server/api/statuses/destroy/12345.json or
        	http://server/api/statuses/destroy/23456.xml

	*/
	function destroy($args, $apidata) {

		parent::handle($args);

		if (!in_array($apidata['content-type'], array('xml', 'json'))) {
			common_user_error(_('API method not found!'), $code = 404);
			return;
		}

		// Check for RESTfulness
		if (!in_array($_SERVER['REQUEST_METHOD'], array('POST', 'DELETE'))) {
			// XXX: Twitter just prints the err msg, no XML / JSON.
			$this->client_error(_('This method requires a POST or DELETE.'), 400, $apidata['content-type']);
			return;
		}

		$user = $apidata['user'];
		$notice_id = $apidata['api_arg'];
		$notice = Notice::staticGet($notice_id);

		if (!$notice) {
			$this->client_error(_('No status found with that ID.'), 404, $apidata['content-type']);
			return;
		}

		if ($user->id == $notice->profile_id) {
			$replies = new Reply;
			$replies->get('notice_id', $notice_id);
			common_dequeue_notice($notice);
			$replies->delete();
			$notice->delete();

			if ($apidata['content-type'] == 'xml') {
				$this->show_single_xml_status($notice);
			} elseif ($apidata['content-type'] == 'json') {
				$this->show_single_json_status($notice);
			}
		} else {
			$this->client_error(_('You may not delete another user\'s status.'), 403, $apidata['content-type']);
		}

	}

	# User Methods

	/*
		Returns up to 100 of the authenticating user's friends who have most recently updated, each with current status inline.
        It's also possible to request another user's recent friends list via the id parameter below.

		 URL: http://server/api/statuses/friends.format

		 Formats: xml, json

		 Parameters:

		 * id. Optional. The ID or screen name of the user for whom to request a list of friends. Ex:
        	http://server/api/statuses/friends/12345.json
			or
			http://server/api/statuses/friends/bob.xml
		 * page. Optional. Retrieves the next 100 friends. Ex: http://server/api/statuses/friends.xml?page=2
		 * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. Ex:
        	http://server/api/statuses/friends.xml?lite=true
		 * since. Optional. Narrows the returned results to just those friendships created after the specified
  			HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in your HTTP
  			request. Ex: http://server/api/statuses/friends.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
	*/
	function friends($args, $apidata) {
		parent::handle($args);
		return $this->subscriptions($apidata, 'subscribed', 'subscriber');
	}

	/*
		Returns the authenticating user's followers, each with current status inline. They are ordered by the
		order in which they joined Twitter (this is going to be changed).

		URL: http://server/api/statuses/followers.format
		Formats: xml, json

		Parameters:

		    * id. Optional. The ID or screen name of the user for whom to request a list of followers. Ex:
            	http://server/api/statuses/followers/12345.json
				or
				http://server/api/statuses/followers/bob.xml
		    * page. Optional. Retrieves the next 100 followers. Ex: http://server/api/statuses/followers.xml?page=2
		    * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true.
		 		Ex: http://server/api/statuses/followers.xml?lite=true
	*/
	function followers($args, $apidata) {
		parent::handle($args);

		return $this->subscriptions($apidata, 'subscriber', 'subscribed');
	}

	function subscriptions($apidata, $other_attr, $user_attr) {

		$user = $this->get_subs_user($apidata);

		# XXX: id
		# XXX: lite

		$page = $this->trimmed('page');

		if (!$page || !is_numeric($page)) {
			$page = 1;
		}

		$profile = $user->getProfile();

		if (!$profile) {
			common_server_error(_('User has no profile.'));
			return;
		}

		$sub = new Subscription();
		$sub->$user_attr = $profile->id;
		$sub->orderBy('created DESC');
		$sub->limit(($page-1)*100, 100);

		$others = array();

		if ($sub->find()) {
			while ($sub->fetch()) {
				$others[] = Profile::staticGet($sub->$other_attr);
			}
		} else {
			// user has no followers
		}

		$type = $apidata['content-type'];

		$this->init_document($type);
		$this->show_profiles($others, $type);
		$this->end_document($type);
	}

	function get_subs_user($apidata) {

		// function was called with an argument /statuses/user_timeline/api_arg.format
		if (isset($apidata['api_arg'])) {

			if (is_numeric($apidata['api_arg'])) {
				$user = User::staticGet($apidata['api_arg']);
			} else {
				$nickname = common_canonical_nickname($apidata['api_arg']);
				$user = User::staticGet('nickname', $nickname);
			}
		} else {

			// if no user was specified, then we'll use the authenticated user
			$user = $apidata['user'];
		}

		if (!$user) {
			// Set the user to be the auth user if asked-for can't be found
			// honestly! This is what Twitter does, I swear --Zach
			$user = $apidata['user'];
		}

		return $user;
	}

	function show_profiles($profiles, $type) {
		switch ($type) {
		 case 'xml':
			common_element_start('users', array('type' => 'array'));
			foreach ($profiles as $profile) {
				$this->show_profile($profile);
			}
			common_element_end('users');
			break;
		 case 'json':
			$arrays = array();
			foreach ($profiles as $profile) {
				$arrays[] = $this->twitter_user_array($profile, true);
			}
			print json_encode($arrays);
			break;
		 default:
			$this->client_error(_('unsupported file type'));
		}
	}

	/*
	Returns a list of the users currently featured on the site with their current statuses inline.
	URL: http://server/api/statuses/featured.format

	Formats: xml, json
	*/
	function featured($args, $apidata) {
		parent::handle($args);
		common_server_error(_('API method under construction.'), $code=501);
	}

	function get_user($id, $apidata) {
		if (!$id) {
			return $apidata['user'];
		} else if (is_numeric($id)) {
			return User::staticGet($id);
		} else {
			return User::staticGet('nickname', $id);
		}
	}

	function supported($cmd) {

		$cmdlist = array('MessageCommand', 'SubCommand', 'UnsubCommand', 'FavCommand', 'OnCommand', 'OffCommand');

		if (in_array(get_class($cmd), $cmdlist)) {
			return true;
		}

		return false;
	}

}