forked from Automattic/liveblog
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathliveblog.php
1219 lines (1022 loc) · 39.9 KB
/
liveblog.php
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
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Plugin Name: Liveblog
* Plugin URI: http://wordpress.org/extend/plugins/liveblog/
* Description: Blogging: at the speed of live.
* Version: 1.5
* Author: WordPress.com VIP, Automattic
* Author URI: http://vip.wordpress.com/
* Text Domain: liveblog
*/
if ( ! class_exists( 'WPCOM_Liveblog' ) ) :
/**
* The main Liveblog class used to setup everything this plugin needs.
*
* Liveblog currently uses a custom comment-type to circumvent post cache
* issues frequently experienced by other live-blog implimentations. It comes
* with a simple and effective templating mechanism, complete with all of the
* CSS, JS, and AJAX needed to make this a turn-key installation.
*
* This class is a big container for a bunch of static methods, similar to a
* factory but without object inheritance or instantiation.
*
* Things yet to be implemented:
*
* -- Change "Read More" to "View Liveblog"
* -- Manual refresh button
* -- Allow marking of liveblog as ended
* -- Allow comment modifications; need to store modified date as comment_meta
*/
final class WPCOM_Liveblog {
/** Constants *************************************************************/
const version = '1.4';
const rewrites_version = 1;
const min_wp_version = '3.5';
const key = 'liveblog';
const url_endpoint = 'liveblog';
const edit_cap = 'publish_posts';
const nonce_key = 'liveblog_nonce';
const refresh_interval = 10; // how often should we refresh
const debug_refresh_interval = 2; // how often we refresh in development mode
const max_consecutive_retries = 100; // max number of failed tries before polling is disabled
const human_time_diff_update_interval = 60; // how often we change the entry human timestamps: "a minute ago"
const delay_threshold = 5; // how many failed tries after which we should increase the refresh interval
const delay_multiplier = 2; // by how much should we inscrease the refresh interval
const fade_out_duration = 5; // how much time should take fading out the background of new entries
/** Variables *************************************************************/
private static $post_id = null;
private static $entry_query = null;
private static $do_not_cache_response = false;
private static $custom_template_path = null;
/** Load Methods **********************************************************/
/**
* @uses add_action() to hook methods into WordPress actions
* @uses add_filter() to hook methods into WordPress filters
*/
public static function load() {
load_plugin_textdomain( 'liveblog', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
if ( self::is_wp_too_old() ) {
self::add_old_wp_notice();
return;
}
self::includes();
self::add_actions();
self::add_filters();
self::add_admin_actions();
self::add_admin_filters();
self::register_embed_handlers();
WPCOM_Liveblog_Entry_Key_Events::load();
WPCOM_Liveblog_Entry_Extend::load();
WPCOM_Liveblog_Lazyloader::load();
}
public static function add_custom_post_type_support( $query ) {
if ( ! self::is_entries_ajax_request() )
return;
$post_types = array_filter( get_post_types(), array( __CLASS__, 'liveblog_post_type' ) );
$query->set( 'post_type', $post_types );
}
public static function liveblog_post_type( $post_type ) {
return post_type_supports( $post_type, self::key );
}
private static function add_old_wp_notice() {
add_action( 'admin_notices', array( 'WPCOM_Liveblog', 'show_old_wp_notice' ) );
}
public static function show_old_wp_notice() {
global $wp_version;
$min_version = self::min_wp_version;
echo self::get_template_part( 'old-wp-notice.php', compact( 'wp_version', 'min_version' ) );
}
/**
* Include the necessary files
*/
private static function includes() {
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-query.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-key-events.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-extend.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-extend-feature.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-extend-feature-hashtags.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-extend-feature-commands.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-extend-feature-emojis.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-extend-feature-authors.php' );
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-lazyloader.php' );
// Manually include ms.php theme-side in multisite environments because
// we need its filesize and available space functions.
if ( ! is_admin() && is_multisite() ) {
require_once( ABSPATH . 'wp-admin/includes/ms.php' );
}
if ( defined( 'WP_CLI' ) && WP_CLI ) {
require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-wp-cli.php' );
}
}
/**
* Hook actions in that run on every page-load
*
* @uses add_action()
*/
private static function add_actions() {
add_action( 'init', array( __CLASS__, 'init' ) );
add_action( 'init', array( __CLASS__, 'add_rewrite_rules' ) );
add_action( 'permalink_structure_changed', array( __CLASS__, 'add_rewrite_rules' ) );
// flush the rewrite rules a lot later so that we don't interfere with other plugins using rewrite rules
add_action( 'init', array( __CLASS__, 'flush_rewrite_rules' ), 1000 );
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'enqueue_scripts' ) );
add_action( 'admin_enqueue_scripts', array( __CLASS__, 'admin_enqueue_scripts' ) );
add_action( 'wp_ajax_set_liveblog_state_for_post', array( __CLASS__, 'admin_ajax_set_liveblog_state_for_post' ) );
add_action( 'pre_get_posts', array( __CLASS__, 'add_custom_post_type_support' ) );
}
/**
* Hook filters in that run on every page-load
*
* @uses add_filter()
*/
private static function add_filters() {
add_filter( 'template_redirect', array( __CLASS__, 'handle_request' ), 9 );
add_filter( 'comment_class', array( __CLASS__, 'add_comment_class' ), 10, 3 );
add_filter( 'is_protected_meta', array( __CLASS__, 'protect_liveblog_meta_key' ), 10, 2 );
}
/**
* Hook actions in that run on every admin page-load
*
* @uses add_action()
* @uses is_admin()
*/
private static function add_admin_actions() {
// Bail if not in admin area
if ( ! is_admin() )
return;
add_action( 'add_meta_boxes', array( __CLASS__, 'add_meta_box' ) );
add_action( 'restrict_manage_posts', array( __CLASS__, 'add_post_filtering_dropdown_to_manage_posts' ) );
add_action( 'pre_get_posts', array( __CLASS__, 'handle_query_vars_for_post_filtering' ) );
}
/**
* Hook filters in that run on every admin page-load
*
* @uses add_filter()
* @uses is_admin()
*/
private static function add_admin_filters() {
// Bail if not in admin area
if ( ! is_admin() )
return;
add_filter( 'display_post_states', array( __CLASS__, 'add_display_post_state' ), 10, 2 );
add_filter( 'query_vars', array( __CLASS__, 'add_query_var_for_post_filtering' ) );
}
private static function register_embed_handlers() {
// register it to run later, because the regex is pretty general and we don't want it to prevent more specific handlers from running
wp_embed_register_handler( 'liveblog_image', '/\.(png|jpe?g|gif)(\?.*)?$/', array( 'WPCOM_Liveblog', 'image_embed_handler' ), 99 );
}
/** Public Methods ********************************************************/
/**
* Liveblog initialization functions.
*
* This is where Liveblog sets up any additional things it needs to run
* inside of WordPress. Where some plugins would register post types or
* taxonomies, we modify endpoints and add post type support for Liveblog.
*/
public static function init() {
/**
* Add liveblog support to the 'post' post type. This is done here so
* we can possibly introduce this to other post types later.
*/
add_post_type_support( 'post', self::key );
do_action( 'after_liveblog_init' );
}
public static function add_rewrite_rules() {
add_rewrite_endpoint( self::url_endpoint, EP_PERMALINK );
}
public static function flush_rewrite_rules() {
if ( get_option( 'liveblog_rewrites_version' ) != self::rewrites_version ) {
flush_rewrite_rules();
update_option( 'liveblog_rewrites_version', self::rewrites_version );
}
}
/**
* This is where a majority of the magic happens.
*
* Hooked to template_redirect, this method tries to add anything it can to
* the current post output. If nothing needs to be added, we redirect back
* to the permalink.
*
* @return If request has been handled
*/
public static function handle_request() {
if ( ! self::is_viewing_liveblog_post() )
return;
self::$post_id = get_the_ID();
self::$custom_template_path = apply_filters( 'liveblog_template_path', self::$custom_template_path, self::$post_id );
if( ! is_dir( self::$custom_template_path ) ) {
self::$custom_template_path = null;
} else {
// realpath is used here to ensure we have an absolute path which is necessary to avoid APC related bugs
self::$custom_template_path = untrailingslashit( realpath( self::$custom_template_path ) );
}
self::$entry_query = new WPCOM_Liveblog_Entry_Query( self::$post_id, self::key );
if ( self::is_initial_page_request() ) {
// we need to add the liveblog after the shortcodes are run, because we already
// process shortcodes in the comment contents and if we left any (like in the original content)
// we wouldn't like them to be processed
add_filter( 'the_content', array( __CLASS__, 'add_liveblog_to_content' ), 20 );
} else {
self::handle_ajax_request();
}
}
private static function handle_ajax_request() {
$endpoint_suffix = get_query_var( self::url_endpoint );
if ( !$endpoint_suffix ) {
// we redirect, because if somebody accessed <permalink>/liveblog
// they probably did that in the URL bar, not via AJAX
wp_safe_redirect( get_permalink() );
exit();
}
wp_cache_delete( self::key . '_entries_asc_' . self::$post_id, 'liveblog' );
$suffix_to_method = array(
'\d+/\d+' => 'ajax_entries_between',
'crud' => 'ajax_crud_entry',
'entry' => 'ajax_single_entry',
'lazyload' => 'ajax_lazyload_entries',
'preview' => 'ajax_preview_entry',
);
$response_method = 'ajax_unknown';
foreach( $suffix_to_method as $suffix_re => $method ) {
if ( preg_match( "%^$suffix_re/?%", $endpoint_suffix ) ) {
$response_method = $method;
break;
}
}
self::$response_method();
}
/**
* Look for any new Liveblog entries, and return them via JSON
*/
public static function ajax_entries_between() {
// Set some defaults
$latest_timestamp = 0;
$entries_for_json = array();
// Look for entry boundaries
list( $start_timestamp, $end_timestamp ) = self::get_timestamps_from_query();
// Bail if there is no end timestamp
if ( empty( $end_timestamp ) ) {
self::send_user_error( __( 'A timestamp is missing. Correct URL: <permalink>/liveblog/<from>/</to>/', 'liveblog' ) );
}
// Do not cache if it's too soon
if ( $end_timestamp > time() )
self::$do_not_cache_response = true;
// Get liveblog entries within the start and end boundaries
$entries = self::$entry_query->get_between_timestamps( $start_timestamp, $end_timestamp );
if ( empty( $entries ) ) {
do_action( 'liveblog_entry_request_empty' );
self::json_return( array(
'entries' => array(),
'latest_timestamp' => null
) );
}
/**
* Loop through each liveblog entry, set the most recent timestamp, and
* put the JSON data for each entry into a neat little array.
*/
foreach( $entries as $entry ) {
$latest_timestamp = max( $latest_timestamp, $entry->get_timestamp() );
$entries_for_json[] = $entry->for_json();
}
// Setup our data to return via JSON
$result_for_json = array(
'entries' => $entries_for_json,
'latest_timestamp' => $latest_timestamp,
);
do_action( 'liveblog_entry_request', $result_for_json );
self::json_return( $result_for_json );
}
/**
* Is a given post_id a liveblog enabled post?
*
* @global WP_Post $post
* @param int $post_id
* @return bool
*/
public static function is_liveblog_post( $post_id = null ) {
$state = self::get_liveblog_state( $post_id );
return (bool)$state;
}
/**
* Are we viewing a liveblog post?
*
* @uses is_single()
* @uses is_liveblog_post()
* @return bool
*/
public static function is_viewing_liveblog_post() {
return (bool) ( is_single() && self::is_liveblog_post() );
}
/**
* One of: 'enable', 'archive', false.
*/
public static function get_liveblog_state( $post_id = null ) {
if ( ! is_single() && ! is_admin() ) {
return false;
}
if ( empty( $post_id ) ) {
global $post;
$post_id = $post->ID;
}
$state = get_post_meta( $post_id, self::key, true );
// backwards compatibility with older values
if ( 1 == $state ) {
$state = 'enable';
}
return $state;
}
/** Private _is_ Methods **************************************************/
/**
* Is this the initial page request?
*
* Note that we do not use get_query_var() - it returns '' for all requests,
* which is valid for /post-name/liveblog/
*
* @global WP_Query $wp_query
* @return bool
*/
private static function is_initial_page_request() {
global $wp_query;
return (bool) ! isset( $wp_query->query_vars[self::key] );
}
/**
* Is this an ajax request for the entries?
*
* @uses get_query_var() to check for the url_endpoint
* @return bool
*/
private static function is_entries_ajax_request() {
return (bool) get_query_var( self::url_endpoint );
}
/**
* Get timestamps from the current WP_Query
*
* Ensures that two timestamps exist, and returns a properly formatted empty
* array if not.
*
* @return array
*/
private static function get_timestamps_from_query() {
// Look for timestamps and bail if none
$stamps = rtrim( get_query_var( self::url_endpoint ), '/' );
if ( empty( $stamps ) )
return array( false, false );
// Get timestamps from the query variable
$timestamps = explode( '/', $stamps );
// Bail if there are not 2 timestamps
if ( 2 !== count( $timestamps ) )
return array( false, false );
// Return integer timestamps in an array
return array_map( 'intval', $timestamps );
}
public static function ajax_crud_entry() {
self::ajax_current_user_can_edit_liveblog();
self::ajax_check_nonce();
$args = array();
$crud_action = isset( $_POST['crud_action'] ) ? $_POST['crud_action'] : 0;
if ( !in_array( $crud_action, array( 'insert', 'update', 'delete', 'delete_key' ) ) ) {
self::send_user_error( sprintf( __( 'Invalid entry crud_action: %s', 'liveblog' ), $crud_action ) );
}
$args['post_id'] = isset( $_POST['post_id'] ) ? intval( $_POST['post_id'] ) : 0;
$args['content'] = isset( $_POST['content'] ) ? $_POST['content'] : '';
$args['entry_id'] = isset( $_POST['entry_id'] ) ? intval( $_POST['entry_id'] ) : 0;
$args['user'] = wp_get_current_user();
$entry = call_user_func( array( 'WPCOM_Liveblog_Entry', $crud_action ), $args );
if ( is_wp_error( $entry ) ) {
self::send_server_error( $entry->get_error_message() );
}
// Do not send latest_timestamp. If we send it the client won't get
// older entries. Since we send only the new one, we don't know if there
// weren't any entries in between.
self::json_return( array(
'entries' => array( $entry->for_json() ),
'latest_timestamp' => null
) );
}
/**
* Fetches the Liveblog entry with the ID given in the $_GET superglobal, and returns it via JSON.
*/
public static function ajax_single_entry() {
// The URL is of the form "entry/entry_id".
$fragments = explode( '/', get_query_var( self::url_endpoint ) );
$entry_id = isset( $fragments[1] ) ? $fragments[1] : '';
$entries = array();
$previous_timestamp = 0;
$next_timestamp = 0;
$all_entries = array_values( self::$entry_query->get_all() );
foreach ( $all_entries as $key => $entry ) {
if ( $entry_id !== $entry->get_id() ) {
continue;
}
$entries = array( $entry );
if ( isset( $all_entries[ $key - 1 ] ) ) {
$previous_entry = $all_entries[ $key - 1 ];
$next_timestamp = $previous_entry->get_timestamp();
}
if ( isset( $all_entries[ $key + 1 ] ) ) {
$next_entry = $all_entries[ $key + 1 ];
$previous_timestamp = $next_entry->get_timestamp();
}
break;
}
if ( ! $entries ) {
do_action( 'liveblog_entry_request_empty' );
self::json_return( array( 'entries' => array() ) );
}
$entries_for_json = array();
// Set up an array containing the JSON data for all Liveblog entries.
foreach ( $entries as $entry ) {
$entries_for_json[] = $entry->for_json();
}
// Set up the data to be returned via JSON.
$result_for_json = array(
'entries' => $entries_for_json,
'index' => (int) filter_input( INPUT_GET, 'index' ),
'nextTimestamp' => $next_timestamp,
'previousTimestamp' => $previous_timestamp,
);
do_action( 'liveblog_entry_request', $result_for_json );
self::$do_not_cache_response = true;
self::json_return( $result_for_json );
}
/**
* Fetches all Liveblog entries that are to be lazyloaded, and returns them via JSON.
*/
public static function ajax_lazyload_entries() {
// The URL is of the form "lazyload/optional_max_timestamp/optional_min_timestamp".
$fragments = explode( '/', get_query_var( self::url_endpoint ) );
// Get all Liveblog entries that are to be lazyloaded.
$entries = self::$entry_query->get_for_lazyloading(
isset( $fragments[1] ) ? (int) $fragments[1] : 0,
isset( $fragments[2] ) ? (int) $fragments[2] : 0
);
if ( ! $entries ) {
do_action( 'liveblog_entry_request_empty' );
self::json_return( array(
'entries' => array(),
'index' => (int) filter_input( INPUT_GET, 'index' ),
) );
}
$entries = array_slice( $entries, 0, WPCOM_Liveblog_Lazyloader::get_number_of_entries() );
$entries_for_json = array();
// Set up an array containing the JSON data for all Liveblog entries.
foreach ( $entries as $entry ) {
$entries_for_json[] = $entry->for_json();
}
// Set up the data to be returned via JSON.
$result_for_json = array(
'entries' => $entries_for_json,
'index' => (int) filter_input( INPUT_GET, 'index' ),
);
do_action( 'liveblog_entry_request', $result_for_json );
self::$do_not_cache_response = true;
self::json_return( $result_for_json );
}
public static function ajax_preview_entry() {
$entry_content = isset( $_REQUEST['entry_content'] ) ? $_REQUEST['entry_content'] : '';
$entry_content = stripslashes( wp_filter_post_kses( $entry_content ) );
$entry_content = apply_filters( 'liveblog_before_preview_entry', array( 'content' => $entry_content ) );
$entry_content = $entry_content['content'];
$entry_content = WPCOM_Liveblog_Entry::render_content( $entry_content );
do_action( 'liveblog_preview_entry', $entry_content );
self::json_return( array( 'html' => $entry_content ) );
}
public static function ajax_unknown() {
self::send_user_error( __( 'Unknown liveblog action', 'liveblog' ) );
}
/** Comment Methods *******************************************************/
/**
* Add a liveblog class to each comment, so they can be styled
*
* @param array $classes
* @return string
*/
public static function add_comment_class( $classes, $class, $comment_id ) {
if ( self::key == get_comment_type( $comment_id ) ) {
$classes[] = 'liveblog-entry';
$classes[] = 'liveblog-entry-class-' . $comment_id;
}
return $classes;
}
public static function admin_enqueue_scripts() {
wp_enqueue_style( self::key, plugins_url( 'css/liveblog-admin.css', __FILE__ ) );
wp_enqueue_script( 'liveblog-admin', plugins_url( 'js/liveblog-admin.js', __FILE__ ) );
wp_localize_script( 'liveblog-admin', 'liveblog_admin_settings', array(
'nonce_key' => self::nonce_key,
'nonce' => wp_create_nonce( self::nonce_key ),
'error_message_template' => __( 'Error {error-code}: {error-message}', 'liveblog' ),
'short_error_message_template' => __( 'Error: {error-message}', 'liveblog' ),
) );
}
/**
* Enqueue the necessary CSS and JS that liveblog needs to function.
*
* @return If not a liveblog post
*/
public static function enqueue_scripts() {
if ( ! self::is_viewing_liveblog_post() )
return;
wp_enqueue_style( self::key, plugins_url( 'css/liveblog.css', __FILE__ ) );
wp_register_script( 'jquery-throttle', plugins_url( 'js/jquery.ba-throttle-debounce.min.js', __FILE__ ) );
wp_register_script( 'moment', plugins_url( 'js/moment.min.js', __FILE__ ), array(), '1.7.2' );
wp_localize_script( 'moment', 'momentLang', array(
'locale' => get_locale(),
'relativeTime' => array(
'past' => __( '%s ago', 'liveblog' ),
's' => __( 'a few seconds', 'liveblog' ),
'm' => __( 'a minute', 'liveblog' ),
'mm' => __( '%d minutes', 'liveblog' ),
'h' => __( 'an hour', 'liveblog' ),
'hh' => __( '%d hours', 'liveblog' ),
'd' => __( 'a day', 'liveblog' ),
'dd' => __( '%d days', 'liveblog' ),
'M' => __( 'a month', 'liveblog' ),
'MM' => __( '%d months', 'liveblog' ),
'y' => __( 'a year', 'liveblog' ),
'yy' => __( '%d years', 'liveblog' ),
),
));
wp_enqueue_script( self::key, plugins_url( 'js/liveblog.js', __FILE__ ), array( 'jquery', 'jquery-color', 'backbone', 'jquery-throttle', 'moment' ), self::version, true );
if ( self::is_liveblog_editable() ) {
if ( apply_filters( 'liveblog_rich_text_editing_allowed', true ) ) {
wp_enqueue_script( 'editor' );
}
wp_enqueue_script( 'liveblog-publisher', plugins_url( 'js/liveblog-publisher.js', __FILE__ ), array( self::key ), self::version, true );
wp_enqueue_script( 'liveblog-plupload', plugins_url( 'js/plupload.js', __FILE__ ), array( self::key, 'wp-plupload', 'jquery' ) );
self::add_default_plupload_settings();
}
if ( wp_script_is( 'jquery.spin', 'registered' ) ) {
wp_enqueue_script( 'jquery.spin' );
} else {
wp_enqueue_script( 'spin', plugins_url( 'js/spin.js', __FILE__ ), false, '1.3' );
wp_enqueue_script( 'jquery.spin', plugins_url( 'js/jquery.spin.js', __FILE__ ), array( 'jquery', 'spin' ), '1.3' );
}
wp_localize_script( self::key, 'liveblog_settings',
apply_filters( 'liveblog_settings', array(
'permalink' => get_permalink(),
'post_id' => get_the_ID(),
'state' => self::get_liveblog_state(),
'key' => self::key,
'nonce_key' => self::nonce_key,
'nonce' => wp_create_nonce( self::nonce_key ),
'latest_entry_timestamp' => self::$entry_query->get_latest_timestamp(),
'refresh_interval' => WP_DEBUG? self::debug_refresh_interval : self::refresh_interval,
'max_consecutive_retries'=> self::max_consecutive_retries,
'delay_threshold' => self::delay_threshold,
'delay_multiplier' => self::delay_multiplier,
'fade_out_duration' => self::fade_out_duration,
'endpoint_url' => self::get_entries_endpoint_url(),
'features' => WPCOM_Liveblog_Entry_Extend::get_enabled_features(),
'autocomplete' => WPCOM_Liveblog_Entry_Extend::get_autocomplete(),
'command_class' => apply_filters( 'liveblog_command_class', WPCOM_Liveblog_Entry_Extend_Feature_Commands::$class_prefix ),
// i18n
'delete_confirmation' => __( 'Do you really want to delete this entry? There is no way back.', 'liveblog' ),
'delete_key_confirm' => __( 'Do you want to delete this key entry?', 'liveblog' ),
'error_message_template' => __( 'Error {error-code}: {error-message}', 'liveblog' ),
'short_error_message_template' => __( 'Error: {error-message}', 'liveblog' ),
'new_update' => __( 'Liveblog: {number} new update' , 'liveblog'),
'new_updates' => __( 'Liveblog: {number} new updates' , 'liveblog'),
'create_link_prompt' => __( 'Provide URL for link:', 'liveblog' ),
// Classes
'class_term_prefix' => __( 'term-', 'liveblog' ),
'class_alert' => __( 'type-alert', 'liveblog' ),
'class_key' => __( 'type-key', 'liveblog' ),
) )
);
wp_localize_script( 'liveblog-publisher', 'liveblog_publisher_settings', array(
'loading_preview' => __( 'Loading preview…', 'liveblog' ),
'new_entry_tab_label' => __( 'New Entry', 'liveblog' ),
'new_entry_submit_label' => __( 'Publish Update', 'liveblog' ),
'edit_entry_tab_label' => __( 'Edit Entry', 'liveblog' ),
'edit_entry_submit_label' => __( 'Update', 'liveblog' ),
) );
}
/**
* Sets up some default Plupload settings so we can upload meda theme-side
*
* @global type $wp_scripts
*/
private static function add_default_plupload_settings() {
global $wp_scripts;
$defaults = array(
'runtimes' => 'html5,silverlight,flash,html4',
'file_data_name' => 'async-upload',
'multiple_queues' => true,
'max_file_size' => self::max_upload_size() . 'b',
'url' => admin_url( 'admin-ajax.php', 'relative' ),
'flash_swf_url' => includes_url( 'js/plupload/plupload.flash.swf' ),
'silverlight_xap_url' => includes_url( 'js/plupload/plupload.silverlight.xap' ),
'filters' => array( array( 'title' => __( 'Allowed Files', 'liveblog' ), 'extensions' => '*') ),
'multipart' => true,
'urlstream_upload' => true,
'multipart_params' => array(
'action' => 'upload-attachment',
'_wpnonce' => wp_create_nonce( 'media-form' )
)
);
$settings = array(
'defaults' => $defaults,
'browser' => array(
'mobile' => wp_is_mobile(),
'supported' => _device_can_upload(),
)
);
$script = 'var _wpPluploadSettings = ' . json_encode( $settings ) . ';';
$data = $wp_scripts->get_data( 'wp-plupload', 'data' );
if ( ! empty( $data ) )
$script = "$data\n$script";
$wp_scripts->add_data( 'wp-plupload', 'data', $script );
}
/**
* Get the URL of a specific liveblog entry.
*
* @return string
*/
private static function get_entries_endpoint_url() {
$post_permalink = get_permalink( self::$post_id );
if ( false !== strpos( $post_permalink, '?p=' ) )
$url = add_query_arg( self::url_endpoint, '', $post_permalink ) . '='; // returns something like ?p=1&liveblog=
else
$url = trailingslashit( trailingslashit( $post_permalink ) . self::url_endpoint ); // returns something like /2012/01/01/post/liveblog/
$url = apply_filters( 'liveblog_endpoint_url', $url, self::$post_id );
return $url;
}
/** Display Methods *******************************************************/
/**
* Filter the_content and add the liveblog theme-side UI above the normal
* content area.
*
* @param string $content
* @return string
*/
public static function add_liveblog_to_content( $content ) {
// We don't want to add the liveblog to other loops
// on the same page
if ( ! self::is_viewing_liveblog_post() ) {
return $content;
}
$liveblog_output = '<div id="liveblog-container" class="'. self::$post_id .'">';
$liveblog_output .= self::get_editor_output();
$liveblog_output .= '<div id="liveblog-update-spinner"></div>';
$liveblog_output .= self::get_all_entry_output();
$liveblog_output .= '</div>';
$liveblog_output = apply_filters( 'liveblog_add_to_content', $liveblog_output, $content, self::$post_id );
return $content . $liveblog_output;
}
/**
* Return the posting area for the end-user to liveblog from
*
* @return string
*/
private static function get_editor_output() {
if ( !self::is_liveblog_editable() )
return;
return self::get_template_part( 'liveblog-form.php' );
}
/**
* Get all the liveblog entries for this post
*/
private static function get_all_entry_output() {
// Get liveblog entries.
$args = array();
$state = self::get_liveblog_state();
if ( 'archive' == $state ) {
$args['order'] = 'ASC';
}
$args = apply_filters( 'liveblog_display_archive_query_args', $args, $state );
$entries = (array) self::$entry_query->get_all( $args );
$show_archived_message = 'archive' == $state && self::current_user_can_edit_liveblog();
// Get the template part
return self::get_template_part( 'liveblog-loop.php', compact( 'entries', 'show_archived_message' ) );
}
/**
* Get the template part in an output buffer and return it
*
* @param string $template_name
* @param array $template_variables
*/
public static function get_template_part( $template_name, $template_variables = array() ) {
ob_start();
extract( $template_variables );
$theme_template = get_template_directory() . '/liveblog/' . ltrim( $template_name, '/' );
if ( file_exists( $theme_template ) ) {
include( $theme_template );
} else if( self::$custom_template_path && file_exists( self::$custom_template_path . '/' . $template_name ) ) {
include( self::$custom_template_path . '/' . $template_name );
} else {
include( dirname( __FILE__ ) . '/templates/' . $template_name );
}
return ob_get_clean();
}
/** Admin Methods *********************************************************/
/**
* Register the metabox with the supporting post-type
*
* @param string $post_type
*/
public static function add_meta_box( $post_type ) {
// Bail if not supported
if ( ! post_type_supports( $post_type, self::key ) )
return;
add_meta_box( self::key, __( 'Liveblog', 'liveblog' ), array( __CLASS__, 'display_meta_box' ) );
}
public static function image_embed_handler( $matches, $attr, $url, $rawattr ) {
$embed = sprintf( '<img src="%s" alt="" />', esc_url( $url ) );
return apply_filters( 'embed_liveblog_image', $embed, $matches, $attr, $url, $rawattr );
}
/**
* Output the metabox
*
* @param WP_Post $post
*/
public static function display_meta_box( $post ) {
$current_state = self::get_liveblog_state( $post->ID );
$buttons = array(
'enable' => array( 'value' => 'enable', 'text' => __( 'Enable', 'liveblog' ),
'description' => __( 'Enables liveblog on this post. Posting tools are enabled for editors, visitors get the latest updates.' , 'liveblog'), 'active-text' => sprintf( __( 'There is an <strong>enabled</strong> liveblog on this post. <a href="%s">Visit the liveblog →</a>', 'liveblog' ), get_permalink( $post ) ), 'primary' => true, 'disabled' => false, ),
'archive' => array( 'value' => 'archive', 'text' => __( 'Archive', 'liveblog' ),
'description' => __( 'Archives the liveblog on this post. Visitors still see the liveblog entries, but posting tools are hidden.' , 'liveblog'), 'active-text' => sprintf( __( 'There is an <strong>archived</strong> liveblog on this post. <a href="%s">Visit the liveblog archive →</a>', 'liveblog' ), get_permalink( $post ) ), 'primary' => false, 'disabled' => false ),
);
if ( $current_state ) {
$active_text = $buttons[$current_state]['active-text'];
$buttons[$current_state]['disabled'] = true;
} else {
$active_text = __( 'This is a normal WordPress post, without a liveblog.', 'liveblog' );
$buttons['archive']['disabled'] = true;
}
$update_text = __( 'Settings have been successfully updated.', 'liveblog' );
$extra_fields = array();
$extra_fields = apply_filters( 'liveblog_admin_add_settings', $extra_fields, $post->ID );
echo self::get_template_part( 'meta-box.php', compact( 'active_text', 'buttons', 'update_text', 'extra_fields' ) );
}
public static function admin_ajax_set_liveblog_state_for_post() {
$post_id = isset( $_REQUEST['post_id'] )? $_REQUEST['post_id'] : 0;
$new_state = isset( $_REQUEST['state'] )? $_REQUEST['state'] : '';
self::ajax_current_user_can_edit_liveblog();
self::ajax_check_nonce();
if ( !$REQUEST = get_post( $post_id ) ) {
self::send_user_error( __( "Non-existing post ID: $post_id" , 'liveblog') );
}
if ( wp_is_post_revision( $post_id ) ) {
self::send_user_error( __( "The post is a revision: $post_id" , 'liveblog') );
}
do_action( 'liveblog_admin_settings_update', $_REQUEST, $post_id );
self::set_liveblog_state( $post_id, $_REQUEST['state'] );
self::display_meta_box( $REQUEST );
exit;
}
private static function set_liveblog_state( $post_id, $state ) {
if ( in_array( $state, array( 'enable', 'archive' ) ) ) {
update_post_meta( $post_id, self::key, $state );
do_action( "liveblog_{$state}_post", $post_id );
} elseif ( 'disable' == $state ) {
delete_post_meta( $post_id, self::key );
do_action( 'liveblog_disable_post', $post_id );
} else {
return false;
}
}
/**
* Indicate in the post list that a post is a liveblog
*
* @param array $post_states
* @param mixed $post
* @return array
* @filter display_post_states
*/
public static function add_display_post_state( $post_states, $post = null ) {
if ( is_null( $post ) ) {
$post = get_post();
}
if ( self::is_liveblog_post( $post->ID ) ) {
$liveblog_state = self::get_liveblog_state( $post->ID );
if ( 'enable' === $liveblog_state ) {
$post_states[] = __( 'Liveblog', 'liveblog' );
}
else if ( 'archive' === $liveblog_state ) {
$post_states[] = __( 'Liveblog (archived)', 'liveblog' );
}
}
return $post_states;
}
/**
* Register the query_var for filtering posts by liveblog state
*
* @param array $query_vars
* @return array
* @filter query_vars
*/
public static function add_query_var_for_post_filtering( $query_vars ) {
$query_vars[] = 'liveblog_state';
return $query_vars;
}
/**
* Render the liveblog state select to filter posts in the post table
*
* @action restrict_manage_posts
*/
public static function add_post_filtering_dropdown_to_manage_posts() {
$current_screen = get_current_screen();
if ( ! post_type_supports( $current_screen->post_type, self::key ) ) {
return;
}
$options = array(
'' => __( 'Filter liveblogs', 'liveblog' ),
'any' => __( 'Any liveblogs', 'liveblog' ),
'enable' => __( 'Enabled liveblogs', 'liveblog' ),
'archive' => __( 'Archived liveblogs', 'liveblog' ),
'none' => __( 'No liveblogs', 'liveblog' ),
);
echo self::get_template_part( 'restrict-manage-posts.php', compact( 'options' ) );
}
/**