Skip to content
This repository
Newer
Older
100644 826 lines (686 sloc) 26.338 kb
8ff4206e »
2012-06-05 v1
1 <?php
0a0ca28b »
2012-07-30 Weekend updates:
2
8ff4206e »
2012-06-05 v1
3 /**
4 * Plugin Name: Liveblog
1fc681ae »
2012-09-04 Add metadata URLs
5 * Plugin URI: http://wordpress.org/extend/plugins/liveblog/
8ff4206e »
2012-06-05 v1
6 * Description: Blogging: at the speed of live.
aa5c82c3 »
2012-12-13 Bump 1.2
7 * Version: 1.2
0a0ca28b »
2012-07-30 Weekend updates:
8 * Author: WordPress.com VIP, Automattic
1fc681ae »
2012-09-04 Add metadata URLs
9 * Author URI: http://vip.wordpress.com/
10 * Text Domain: liveblog
8ff4206e »
2012-06-05 v1
11 */
12
13 if ( ! class_exists( 'WPCOM_Liveblog' ) ) :
14
0a0ca28b »
2012-07-30 Weekend updates:
15 /**
16 * The main Liveblog class used to setup everything this plugin needs.
17 *
18 * Liveblog currently uses a custom comment-type to circumvent post cache
19 * issues frequently experienced by other live-blog implimentations. It comes
20 * with a simple and effective templating mechanism, complete with all of the
21 * CSS, JS, and AJAX needed to make this a turn-key installation.
22 *
23 * This class is a big container for a bunch of static methods, similar to a
24 * factory but without object inheritance or instantiation.
8413aff2 »
2012-07-31 Uploading:
25 *
5ad84ba6 »
2012-09-04 Fix typo
26 * Things yet to be implemented:
0a0ca28b »
2012-07-30 Weekend updates:
27 *
28 * -- Change "Read More" to "View Liveblog"
29 * -- Manual refresh button
30 * -- Allow marking of liveblog as ended
31 * -- Allow comment modifications; need to store modified date as comment_meta
32 */
33 final class WPCOM_Liveblog {
34
35 /** Constants *************************************************************/
8ff4206e »
2012-06-05 v1
36
aa5c82c3 »
2012-12-13 Bump 1.2
37 const version = '1.2';
1d5d7f9c »
2012-09-01 Flush the rewrite rules on rules update
38 const rewrites_version = 1;
cd6d5741 »
2012-07-26 * Code clean up.
39 const key = 'liveblog';
40 const url_endpoint = 'liveblog';
41 const edit_cap = 'publish_posts';
42 const nonce_key = 'liveblog_nonce';
8ff4206e »
2012-06-05 v1
43
1d7244f8 »
2012-09-20 Increase the default refresh interval
44 const refresh_interval = 10; // how often should we refresh
ed1991cf »
2012-08-15 Shut the auto-update only on consecutive failures
45 const max_consecutive_retries = 100; // max number of failed tries before polling is disabled
46 const delay_threshold = 5; // how many failed tries after which we should increase the refresh interval
47 const delay_multiplier = 2; // by how much should we inscrease the refresh interval
8ff4206e »
2012-06-05 v1
48
0a0ca28b »
2012-07-30 Weekend updates:
49 /** Variables *************************************************************/
50
51 private static $post_id = null;
52 private static $entry_query = null;
53 private static $do_not_cache_response = false;
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
54
0a0ca28b »
2012-07-30 Weekend updates:
55 /** Load Methods **********************************************************/
56
57 /**
58 * @uses add_action() to hook methods into WordPress actions
59 * @uses add_filter() to hook methods into WordPress filters
60 */
61 public static function load() {
e5351e53 »
2012-09-06 load_plugin_textdomain so the plugin can be translated.
62 load_plugin_textdomain( 'liveblog', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
63
0a0ca28b »
2012-07-30 Weekend updates:
64 self::includes();
65 self::add_actions();
66 self::add_filters();
67 self::add_admin_actions();
68 }
69
70 /**
71 * Include the necessary files
72 */
73 private static function includes() {
74 require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry.php' );
75 require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-entry-query.php' );
e691fe35 »
2012-08-14 Include ms.php theme-side for its filesize and available space functi…
76
77 // Manually include ms.php theme-side in multisite environments because
78 // we need its filesize and available space functions.
79 if ( ! is_admin() && is_multisite() ) {
8f5fb3cc »
2012-08-14 Remove preceding slash. ABSPATH is already slashed for us.
80 require_once( ABSPATH . 'wp-admin/includes/ms.php' );
e691fe35 »
2012-08-14 Include ms.php theme-side for its filesize and available space functi…
81 }
02b5fdb7 »
2012-09-01 Add convertor from extend read me to github readme
82
83 if ( defined( 'WP_CLI' ) && WP_CLI ) {
84 require( dirname( __FILE__ ) . '/classes/class-wpcom-liveblog-wp-cli.php' );
85 }
0a0ca28b »
2012-07-30 Weekend updates:
86 }
8ff4206e »
2012-06-05 v1
87
0a0ca28b »
2012-07-30 Weekend updates:
88 /**
89 * Hook actions in that run on every page-load
90 *
91 * @uses add_action()
92 */
93 private static function add_actions() {
cd6d5741 »
2012-07-26 * Code clean up.
94 add_action( 'init', array( __CLASS__, 'init' ) );
7994c3e2 »
2012-09-18 Re-add the rewrite rules on permalink change
95 add_action( 'init', array( __CLASS__, 'add_rewrite_rules' ) );
96 add_action( 'permalink_structure_changed', array( __CLASS__, 'add_rewrite_rules' ) );
4221823e »
2012-09-18 Flush the rewrite rules later
97 // flush the rewrite rules a lot later so that we don't interfere with other plugins using rewrite rules
98 add_action( 'init', array( __CLASS__, 'flush_rewrite_rules' ), 1000 );
cd6d5741 »
2012-07-26 * Code clean up.
99 add_action( 'wp_enqueue_scripts', array( __CLASS__, 'enqueue_scripts' ) );
ea5a8a60 »
2012-12-18 Introduce archiving
100 add_action( 'admin_enqueue_scripts', array( __CLASS__, 'admin_enqueue_scripts' ) );
101 add_action( 'wp_ajax_set_liveblog_state_for_post', array( __CLASS__, 'admin_ajax_set_liveblog_state_for_post' ) );
0a0ca28b »
2012-07-30 Weekend updates:
102 }
8ff4206e »
2012-06-05 v1
103
0a0ca28b »
2012-07-30 Weekend updates:
104 /**
105 * Hook filters in that run on every page-load
106 *
107 * @uses add_filter()
108 */
109 private static function add_filters() {
cd6d5741 »
2012-07-26 * Code clean up.
110 add_filter( 'template_redirect', array( __CLASS__, 'handle_request' ) );
c3dc8bd0 »
2012-09-21 Only apply liveblog-entry CSS class to liveblog comment types.
111 add_filter( 'comment_class', array( __CLASS__, 'add_comment_class' ), 10, 3 );
8ff4206e »
2012-06-05 v1
112 }
113
cd6d5741 »
2012-07-26 * Code clean up.
114 /**
0a0ca28b »
2012-07-30 Weekend updates:
115 * Hook actions in that run on every admin page-load
116 *
117 * @uses add_action()
118 * @uses is_admin()
119 */
120 private static function add_admin_actions() {
121
122 // Bail if not in admin area
123 if ( ! is_admin() )
124 return;
125
126 add_action( 'add_meta_boxes', array( __CLASS__, 'add_meta_box' ) );
127 }
128
129 /** Public Methods ********************************************************/
130
131 /**
132 * Liveblog initialization functions.
133 *
134 * This is where Liveblog sets up any additional things it needs to run
135 * inside of WordPress. Where some plugins would register post types or
136 * taxonomies, we modify endpoints and add post type support for Liveblog.
cd6d5741 »
2012-07-26 * Code clean up.
137 */
0a0ca28b »
2012-07-30 Weekend updates:
138 public static function init() {
139 /**
140 * Add liveblog support to the 'post' post type. This is done here so
141 * we can possibly introduce this to other post types later.
142 */
8ff4206e »
2012-06-05 v1
143 add_post_type_support( 'post', self::key );
8314495d »
2012-10-23 Add an action after liveblog's init
144 do_action( 'after_liveblog_init' );
8ff4206e »
2012-06-05 v1
145 }
146
7994c3e2 »
2012-09-18 Re-add the rewrite rules on permalink change
147 public function add_rewrite_rules() {
1d5d7f9c »
2012-09-01 Flush the rewrite rules on rules update
148 add_rewrite_endpoint( self::url_endpoint, EP_PERMALINK );
7994c3e2 »
2012-09-18 Re-add the rewrite rules on permalink change
149 }
1d5d7f9c »
2012-09-01 Flush the rewrite rules on rules update
150
7994c3e2 »
2012-09-18 Re-add the rewrite rules on permalink change
151 public static function flush_rewrite_rules() {
1d5d7f9c »
2012-09-01 Flush the rewrite rules on rules update
152 if ( get_option( 'liveblog_rewrites_version' ) != self::rewrites_version ) {
153 flush_rewrite_rules();
154 update_option( 'liveblog_rewrites_version', self::rewrites_version );
155 }
156 }
157
0a0ca28b »
2012-07-30 Weekend updates:
158 /**
159 * This is where a majority of the magic happens.
160 *
161 * Hooked to template_redirect, this method tries to add anything it can to
162 * the current post output. If nothing needs to be added, we redirect back
163 * to the permalink.
164 *
165 * @return If request has been handled
166 */
167 public static function handle_request() {
168
8ff4206e »
2012-06-05 v1
169 if ( ! self::is_viewing_liveblog_post() )
170 return;
171
cd6d5741 »
2012-07-26 * Code clean up.
172 self::$post_id = get_the_ID();
b28b38d5 »
2012-07-19 Rename the query class to match WP conventions
173 self::$entry_query = new WPCOM_Liveblog_Entry_Query( self::$post_id, self::key );
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
174
4872b2ad »
2012-08-23 Use front-end AJAX URLs for same-origin requests
175 if ( self::is_initial_page_request() )
8ff4206e »
2012-06-05 v1
176 add_filter( 'the_content', array( __CLASS__, 'add_liveblog_to_content' ) );
4872b2ad »
2012-08-23 Use front-end AJAX URLs for same-origin requests
177 else
178 self::handle_ajax_request();
179 }
180
181 private static function handle_ajax_request() {
182
183 $endpoint_suffix = get_query_var( self::url_endpoint );
184
185 if ( !$endpoint_suffix ) {
186 // we redirect, because if somebody accessed <permalink>/liveblog
187 // they probably did that in the URL bar, not via AJAX
188 wp_safe_redirect( get_permalink() );
189 exit();
8ff4206e »
2012-06-05 v1
190 }
2b0244cf »
2012-09-18 Remove trailing whitespace
191 wp_cache_delete( self::key . '_entries_asc_' . self::$post_id, 'liveblog' );
8ff4206e »
2012-06-05 v1
192
4872b2ad »
2012-08-23 Use front-end AJAX URLs for same-origin requests
193 $suffix_to_method = array(
194 '\d+/\d+' => 'ajax_entries_between',
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
195 'crud' => 'ajax_crud_entry',
4872b2ad »
2012-08-23 Use front-end AJAX URLs for same-origin requests
196 'preview' => 'ajax_preview_entry',
197 );
198
199 $response_method = 'ajax_unknown';
200
201 foreach( $suffix_to_method as $suffix_re => $method ) {
202 if ( preg_match( "%^$suffix_re/?%", $endpoint_suffix ) ) {
203 $response_method = $method;
204 break;
205 }
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
206 }
207
4872b2ad »
2012-08-23 Use front-end AJAX URLs for same-origin requests
208 self::$response_method();
209
8ff4206e »
2012-06-05 v1
210 }
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
211
0a0ca28b »
2012-07-30 Weekend updates:
212 /**
213 * Look for any new Liveblog entries, and return them via JSON
214 */
215 public static function ajax_entries_between() {
216
217 // Set some defaults
cd6d5741 »
2012-07-26 * Code clean up.
218 $latest_timestamp = 0;
219 $entries_for_json = array();
558008c4 »
2012-07-04 Use the same current timestamp at all places
220
0a0ca28b »
2012-07-30 Weekend updates:
221 // Look for entry boundaries
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
222 list( $start_timestamp, $end_timestamp ) = self::get_timestamps_from_query();
cd6d5741 »
2012-07-26 * Code clean up.
223
0a0ca28b »
2012-07-30 Weekend updates:
224 // Bail if there is no end timestamp
cd6d5741 »
2012-07-26 * Code clean up.
225 if ( empty( $end_timestamp ) ) {
70b347ae »
2012-09-06 Add missing textdomain to translated strings
226 self::send_user_error( __( 'A timestamp is missing. Correct URL: <permalink>/liveblog/<from>/</to>/', 'liveblog' ) );
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
227 }
228
0a0ca28b »
2012-07-30 Weekend updates:
229 // Do not cache if it's too soon
bd6c841d »
2012-08-21 Use the Date header to get server-side date
230 if ( $end_timestamp > time() )
6c667576 »
2012-07-04 Do not let the client cache future requests
231 self::$do_not_cache_response = true;
232
0a0ca28b »
2012-07-30 Weekend updates:
233 // Get liveblog entries within the start and end boundaries
b28b38d5 »
2012-07-19 Rename the query class to match WP conventions
234 $entries = self::$entry_query->get_between_timestamps( $start_timestamp, $end_timestamp );
0a0ca28b »
2012-07-30 Weekend updates:
235 if ( empty( $entries ) ) {
7e39692c »
2012-09-25 Introduce some new hooks.
236 do_action( 'liveblog_entry_request_empty' );
237
0a0ca28b »
2012-07-30 Weekend updates:
238 self::json_return( array(
239 'entries' => array(),
240 'latest_timestamp' => null
241 ) );
242 }
d79a82d3 »
2012-07-05 Gather common entry functionality in a new class
243
0a0ca28b »
2012-07-30 Weekend updates:
244 /**
245 * Loop through each liveblog entry, set the most recent timestamp, and
246 * put the JSON data for each entry into a neat little array.
247 */
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
248 foreach( $entries as $entry ) {
cd6d5741 »
2012-07-26 * Code clean up.
249 $latest_timestamp = max( $latest_timestamp, $entry->get_timestamp() );
d79a82d3 »
2012-07-05 Gather common entry functionality in a new class
250 $entries_for_json[] = $entry->for_json();
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
251 }
252
0a0ca28b »
2012-07-30 Weekend updates:
253 // Setup our data to return via JSON
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
254 $result_for_json = array(
cd6d5741 »
2012-07-26 * Code clean up.
255 'entries' => $entries_for_json,
256 'latest_timestamp' => $latest_timestamp,
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
257 );
258
7e39692c »
2012-09-25 Introduce some new hooks.
259 do_action( 'liveblog_entry_request', $result_for_json );
260
e9775618 »
2012-07-11 Get rid of extra json_return() arguments
261 self::json_return( $result_for_json );
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
262 }
263
0a0ca28b »
2012-07-30 Weekend updates:
264 /** Private _is_ Methods **************************************************/
265
266 /**
267 * Are we viewing a liveblog post?
268 *
269 * @uses is_single()
270 * @uses is_liveblog_post()
271 * @return bool
272 */
273 private static function is_viewing_liveblog_post() {
274 return (bool) ( is_single() && self::is_liveblog_post() );
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
275 }
276
0a0ca28b »
2012-07-30 Weekend updates:
277 /**
278 * Is this the initial page request?
279 *
280 * Note that we do not use get_query_var() - it returns '' for all requests,
281 * which is valid for /post-name/liveblog/
282 *
283 * @global WP_Query $wp_query
284 * @return bool
285 */
286 private static function is_initial_page_request() {
8ff4206e »
2012-06-05 v1
287 global $wp_query;
0a0ca28b »
2012-07-30 Weekend updates:
288
289 return (bool) ! isset( $wp_query->query_vars[self::key] );
8ff4206e »
2012-06-05 v1
290 }
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
291
0a0ca28b »
2012-07-30 Weekend updates:
292 /**
293 * Is this an ajax request for the entries?
294 *
295 * @uses get_query_var() to check for the url_endpoint
296 * @return bool
297 */
298 private static function is_entries_ajax_request() {
299 return (bool) get_query_var( self::url_endpoint );
300 }
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
301
0a0ca28b »
2012-07-30 Weekend updates:
302 /**
303 * Is a given post_id a liveblog enabled post?
304 *
305 * @global WP_Post $post
306 * @param int $post_id
307 * @return bool
308 */
309 private static function is_liveblog_post( $post_id = null ) {
ea5a8a60 »
2012-12-18 Introduce archiving
310 $state = self::get_liveblog_state( $post_id );
8c3cdd8d »
2012-12-20 Remove the Disable button
311 return (bool)$state;
ea5a8a60 »
2012-12-18 Introduce archiving
312 }
313
8c3cdd8d »
2012-12-20 Remove the Disable button
314 /**
315 * One of: 'enable', 'archive', false.
316 */
ea5a8a60 »
2012-12-18 Introduce archiving
317 private static function get_liveblog_state( $post_id = null ) {
0a0ca28b »
2012-07-30 Weekend updates:
318 if ( empty( $post_id ) ) {
319 global $post;
320 $post_id = $post->ID;
321 }
ea5a8a60 »
2012-12-18 Introduce archiving
322 $state = get_post_meta( $post_id, self::key, true );
323 // backwards compatibility with older values
324 if ( 1 == $state ) {
325 $state = 'enable';
326 }
327 return $state;
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
328 }
329
0a0ca28b »
2012-07-30 Weekend updates:
330 /**
331 * Get timestamps from the current WP_Query
332 *
333 * Ensures that two timestamps exist, and returns a properly formatted empty
334 * array if not.
335 *
336 * @return array
337 */
338 private static function get_timestamps_from_query() {
339
340 // Look for timestamps and bail if none
25be635c »
2012-09-04 Support for non-pretty permalinks
341 $stamps = rtrim( get_query_var( self::url_endpoint ), '/' );
0a0ca28b »
2012-07-30 Weekend updates:
342 if ( empty( $stamps ) )
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
343 return array( false, false );
0a0ca28b »
2012-07-30 Weekend updates:
344
345 // Get timestamps from the query variable
346 $timestamps = explode( '/', $stamps );
347
348 // Bail if there are not 2 timestamps
349 if ( 2 !== count( $timestamps ) )
350 return array( false, false );
351
352 // Return integer timestamps in an array
353 return array_map( 'intval', $timestamps );
1b8e8d5e »
2012-07-02 Streamline logic for getting recent entries
354 }
355
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
356 public static function ajax_crud_entry() {
b58c3a07 »
2012-07-04 Remove leading underscores from function names
357 self::ajax_current_user_can_edit_liveblog();
358 self::ajax_check_nonce();
8ff4206e »
2012-06-05 v1
359
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
360 $args = array();
8ff4206e »
2012-06-05 v1
361
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
362 $crud_action = isset( $_POST['crud_action'] ) ? $_POST['crud_action'] : 0;
8ff4206e »
2012-06-05 v1
363
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
364 if ( !in_array( $crud_action, array( 'insert', 'update', 'delete' ) ) ) {
365 self::send_user_error( sprintf( __( 'Invalid entry crud_action: %s', 'liveblog' ), $crud_action ) );
a2723d4f »
2012-07-23 Commit entry modifications
366 }
367
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
368 $args['post_id'] = isset( $_POST['post_id'] ) ? intval( $_POST['post_id'] ) : 0;
369 $args['content'] = isset( $_POST['content'] ) ? $_POST['content'] : '';
370 $args['entry_id'] = isset( $_POST['entry_id'] ) ? intval( $_POST['entry_id'] ) : 0;
e92599ed »
2012-12-26 Switch the delete endpoint to use the new method
371
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
372 $args['user'] = wp_get_current_user();
e92599ed »
2012-12-26 Switch the delete endpoint to use the new method
373
4c7e77ba »
2012-12-26 Consolidate all CRUD AJAX actions
374 $entry = call_user_func( array( 'WPCOM_Liveblog_Entry', $crud_action ), $args );
e92599ed »
2012-12-26 Switch the delete endpoint to use the new method
375
376 if ( is_wp_error( $entry ) ) {
377 self::send_server_error( $entry->get_error_message() );
378 }
379
380 // Do not send latest_timestamp. If we send it the client won't get
381 // older entries. Since we send only the new one, we don't know if there
382 // weren't any entries in between.
383 self::json_return( array(
384 'entries' => array( $entry->for_json() ),
385 'latest_timestamp' => null
386 ) );
387 }
388
5aee5858 »
2012-08-15 Add ajax endpoint for preview
389 function ajax_preview_entry() {
390 $entry_content = isset( $_REQUEST['entry_content'] ) ? $_REQUEST['entry_content'] : '';
54605198 »
2012-10-16 Fix preview which was returning slashed data.
391 $entry_content = stripslashes( wp_filter_post_kses( $entry_content ) );
5aee5858 »
2012-08-15 Add ajax endpoint for preview
392 $entry_content = WPCOM_Liveblog_Entry::render_content( $entry_content );
7e39692c »
2012-09-25 Introduce some new hooks.
393
394 do_action( 'liveblog_preview_entry', $entry_content );
395
5aee5858 »
2012-08-15 Add ajax endpoint for preview
396 self::json_return( array( 'html' => $entry_content ) );
397 }
398
4872b2ad »
2012-08-23 Use front-end AJAX URLs for same-origin requests
399 public function ajax_unknown() {
400 self::send_user_error( __( 'Unknown liveblog action', 'liveblog' ) );
401 }
402
403
0a0ca28b »
2012-07-30 Weekend updates:
404 /** Comment Methods *******************************************************/
8ff4206e »
2012-06-05 v1
405
0a0ca28b »
2012-07-30 Weekend updates:
406 /**
407 * Add a liveblog class to each comment, so they can be styled
408 *
409 * @param array $classes
410 * @return string
411 */
c3dc8bd0 »
2012-09-21 Only apply liveblog-entry CSS class to liveblog comment types.
412 public static function add_comment_class( $classes, $class, $comment_id ) {
413 if ( self::key == get_comment_type( $comment_id ) )
414 $classes[] = 'liveblog-entry';
8ff4206e »
2012-06-05 v1
415 return $classes;
416 }
417
ea5a8a60 »
2012-12-18 Introduce archiving
418 public static function admin_enqueue_scripts() {
419 wp_enqueue_style( self::key, plugins_url( 'css/liveblog-admin.css', __FILE__ ) );
281438dd »
2012-12-20 Use actual information for AJAX action
420 wp_enqueue_script( 'liveblog-admin', plugins_url( 'js/liveblog-admin.js', __FILE__ ) );
421 wp_localize_script( 'liveblog-admin', 'liveblog_admin_settings', array(
422 'nonce_key' => self::nonce_key,
423 'nonce' => wp_create_nonce( self::nonce_key ),
f4e54ce6 »
2012-12-20 Translate JS error messages
424 'error_message_template' => __( 'Error {error-code}: {error-message}', 'liveblog' ),
281438dd »
2012-12-20 Use actual information for AJAX action
425 ) );
ea5a8a60 »
2012-12-18 Introduce archiving
426 }
f1571811 »
2012-07-30 Comment Status:
427
428 /**
0a0ca28b »
2012-07-30 Weekend updates:
429 * Enqueue the necessary CSS and JS that liveblog needs to function.
430 *
431 * @return If not a liveblog post
432 */
433 public static function enqueue_scripts() {
434
8ff4206e »
2012-06-05 v1
435 if ( ! self::is_viewing_liveblog_post() )
436 return;
437
0a0ca28b »
2012-07-30 Weekend updates:
438 wp_enqueue_style( self::key, plugins_url( 'css/liveblog.css', __FILE__ ) );
db742c83 »
2012-08-12 Highlight new posts
439 wp_enqueue_script( self::key, plugins_url( 'js/liveblog.js', __FILE__ ), array( 'jquery', 'jquery-color' ), self::version, true );
cd6d5741 »
2012-07-26 * Code clean up.
440
8413aff2 »
2012-07-31 Uploading:
441 if ( self::current_user_can_edit_liveblog() ) {
a456b551 »
2012-08-15 Add Preview interface
442 wp_enqueue_script( 'liveblog-publisher', plugins_url( 'js/liveblog-publisher.js', __FILE__ ), array( self::key, 'jquery-ui-tabs' ), self::version, true );
212e64d0 »
2012-08-30 Hookable Uploader
443 wp_enqueue_script( 'liveblog-plupload', plugins_url( 'js/plupload.js', __FILE__ ), array( self::key, 'wp-plupload', 'jquery' ) );
c65e58f3 »
2012-08-12 Make the function name a verb
444 self::add_default_plupload_settings();
cd6d5741 »
2012-07-26 * Code clean up.
445 }
8ff4206e »
2012-06-05 v1
446
c0c30852 »
2012-07-04 Add spinner for inserting an entry
447 if ( wp_script_is( 'jquery.spin', 'registered' ) ) {
448 wp_enqueue_script( 'jquery.spin' );
449 } else {
0a0ca28b »
2012-07-30 Weekend updates:
450 wp_enqueue_script( 'spin', plugins_url( 'js/spin.js', __FILE__ ), false, '1.2.4' );
451 wp_enqueue_script( 'jquery.spin', plugins_url( 'js/jquery.spin.js', __FILE__ ), array( 'jquery', 'spin' ) );
c0c30852 »
2012-07-04 Add spinner for inserting an entry
452 }
453
0a0ca28b »
2012-07-30 Weekend updates:
454 wp_localize_script( self::key, 'liveblog_settings',
cd6d5741 »
2012-07-26 * Code clean up.
455 apply_filters( 'liveblog_settings', array(
456 'permalink' => get_permalink(),
457 'post_id' => get_the_ID(),
ea5a8a60 »
2012-12-18 Introduce archiving
458 'state' => self::get_liveblog_state(),
8ff4206e »
2012-06-05 v1
459
cd6d5741 »
2012-07-26 * Code clean up.
460 'key' => self::key,
461 'nonce_key' => self::nonce_key,
462 'latest_entry_timestamp' => self::$entry_query->get_latest_timestamp(),
8ff4206e »
2012-06-05 v1
463
cd6d5741 »
2012-07-26 * Code clean up.
464 'refresh_interval' => self::refresh_interval,
ed1991cf »
2012-08-15 Shut the auto-update only on consecutive failures
465 'max_consecutive_retries'=> self::max_consecutive_retries,
cd6d5741 »
2012-07-26 * Code clean up.
466 'delay_threshold' => self::delay_threshold,
467 'delay_multiplier' => self::delay_multiplier,
8ff4206e »
2012-06-05 v1
468
ea5a8a60 »
2012-12-18 Introduce archiving
469 'endpoint_url' => self::get_entries_endpoint_url(),
cd6d5741 »
2012-07-26 * Code clean up.
470
471 // i18n
0a0ca28b »
2012-07-30 Weekend updates:
472 'update_nag_singular' => __( '%d new update', 'liveblog' ),
cd6d5741 »
2012-07-26 * Code clean up.
473 'update_nag_plural' => __( '%d new updates', 'liveblog' ),
28802ffe »
2012-08-01 Delete entry functionality
474 'delete_confirmation' => __( 'Do you really want do delete this entry? There is no way back.', 'liveblog' ),
f4e54ce6 »
2012-12-20 Translate JS error messages
475 'error_message_template' => __( 'Error {error-code}: {error-message}', 'liveblog' ),
cd6d5741 »
2012-07-26 * Code clean up.
476 ) )
477 );
8ff4206e »
2012-06-05 v1
478 }
479
0a0ca28b »
2012-07-30 Weekend updates:
480 /**
8413aff2 »
2012-07-31 Uploading:
481 * Sets up some default Plupload settings so we can upload meda theme-side
482 *
483 * @global type $wp_scripts
484 */
c65e58f3 »
2012-08-12 Make the function name a verb
485 private static function add_default_plupload_settings() {
8413aff2 »
2012-07-31 Uploading:
486 global $wp_scripts;
487
488 $defaults = array(
489 'runtimes' => 'html5,silverlight,flash,html4',
490 'file_data_name' => 'async-upload',
491 'multiple_queues' => true,
492 'max_file_size' => self::max_upload_size() . 'b',
493 'url' => admin_url( 'admin-ajax.php', 'relative' ),
494 'flash_swf_url' => includes_url( 'js/plupload/plupload.flash.swf' ),
495 'silverlight_xap_url' => includes_url( 'js/plupload/plupload.silverlight.xap' ),
70b347ae »
2012-09-06 Add missing textdomain to translated strings
496 'filters' => array( array( 'title' => __( 'Allowed Files', 'liveblog' ), 'extensions' => '*') ),
8413aff2 »
2012-07-31 Uploading:
497 'multipart' => true,
498 'urlstream_upload' => true,
499 'multipart_params' => array(
500 'action' => 'upload-attachment',
501 '_wpnonce' => wp_create_nonce( 'media-form' )
502 )
503 );
504
505 $settings = array(
506 'defaults' => $defaults,
507 'browser' => array(
508 'mobile' => wp_is_mobile(),
509 'supported' => _device_can_upload(),
510 )
511 );
512
513 $script = 'var _wpPluploadSettings = ' . json_encode( $settings ) . ';';
514 $data = $wp_scripts->get_data( 'wp-plupload', 'data' );
515
516 if ( ! empty( $data ) )
517 $script = "$data\n$script";
518
519 $wp_scripts->add_data( 'wp-plupload', 'data', $script );
520 }
521
522 /**
0a0ca28b »
2012-07-30 Weekend updates:
523 * Get the URL of a specific liveblog entry.
524 *
525 * @return string
526 */
527 private static function get_entries_endpoint_url() {
0dccc810 »
2012-09-19 Add correct endpoing to draft URLs with query args
528 $post_permalink = get_permalink( self::$post_id );
529 if ( false !== strpos( $post_permalink, '?p=' ) )
530 $url = add_query_arg( self::url_endpoint, '', $post_permalink ) . '='; // returns something like ?p=1&liveblog=
25be635c »
2012-09-04 Support for non-pretty permalinks
531 else
0dccc810 »
2012-09-19 Add correct endpoing to draft URLs with query args
532 $url = trailingslashit( trailingslashit( $post_permalink ) . self::url_endpoint ); // returns something like /2012/01/01/post/liveblog/
7330fcbe »
2012-09-19 Allow the endpoint URL to be filtered
533 $url = apply_filters( 'liveblog_endpoint_url', $url, self::$post_id );
25be635c »
2012-09-04 Support for non-pretty permalinks
534 return $url;
0a0ca28b »
2012-07-30 Weekend updates:
535 }
cb778e43 »
2012-06-05 Load initial entries server-side rather than via AJAX for SEO benefit
536
0a0ca28b »
2012-07-30 Weekend updates:
537 /** Display Methods *******************************************************/
cd6d5741 »
2012-07-26 * Code clean up.
538
0a0ca28b »
2012-07-30 Weekend updates:
539 /**
540 * Filter the_content and add the liveblog theme-side UI above the normal
541 * content area.
542 *
543 * @param string $content
544 * @return string
545 */
546 public static function add_liveblog_to_content( $content ) {
cb778e43 »
2012-06-05 Load initial entries server-side rather than via AJAX for SEO benefit
547
0a0ca28b »
2012-07-30 Weekend updates:
548 $liveblog_output = '<div id="liveblog-container" class="'. self::$post_id .'">';
549 $liveblog_output .= self::get_editor_output();
550 $liveblog_output .= '<div id="liveblog-update-spinner"></div>';
551 $liveblog_output .= self::get_all_entry_output();
ba2c2ae3 »
2012-06-10 Switch around ids with classes just to be future-safe. Add a new wrap…
552 $liveblog_output .= '</div>';
8ff4206e »
2012-06-05 v1
553
09e766c0 »
2012-09-25 New filter: liveblog_add_to_content
554 $liveblog_output = apply_filters( 'liveblog_add_to_content', $liveblog_output, $content, self::$post_id );
555
7205206d »
2012-08-01 Put the post contents before the liveblog
556 return $content . $liveblog_output;
8ff4206e »
2012-06-05 v1
557 }
558
0a0ca28b »
2012-07-30 Weekend updates:
559 /**
560 * Return the posting area for the end-user to liveblog from
561 *
562 * @return string
563 */
564 private static function get_editor_output() {
b58c3a07 »
2012-07-04 Remove leading underscores from function names
565 if ( ! self::current_user_can_edit_liveblog() )
8ff4206e »
2012-06-05 v1
566 return;
ea5a8a60 »
2012-12-18 Introduce archiving
567 if ( 'archive' == self::get_liveblog_state() ) {
568 return;
569 }
8ff4206e »
2012-06-05 v1
570
0a0ca28b »
2012-07-30 Weekend updates:
571 // Get the template part
572 return self::get_template_part( 'liveblog-form.php' );
8ff4206e »
2012-06-05 v1
573 }
574
0a0ca28b »
2012-07-30 Weekend updates:
575 /**
576 * Get all the liveblog entries for this post
577 */
578 private static function get_all_entry_output() {
8413aff2 »
2012-07-31 Uploading:
579
0a0ca28b »
2012-07-30 Weekend updates:
580 // Get liveblog entries
9c2b7c37 »
2012-08-22 Order entries reverse-chronologically on initial load
581 $entries = (array) self::$entry_query->get_all();
8ff4206e »
2012-06-05 v1
582
0a0ca28b »
2012-07-30 Weekend updates:
583 // Get the template part
584 return self::get_template_part( 'liveblog-loop.php', compact( 'entries' ) );
585 }
586
587 /**
588 * Get the template part in an output buffer and return it
589 *
590 * @param string $template_name
591 * @param array $template_variables
592 */
593 public static function get_template_part( $template_name, $template_variables = array() ) {
594 ob_start();
595 extract( $template_variables );
596 include( dirname( __FILE__ ) . '/templates/' . $template_name );
597 return ob_get_clean();
8ff4206e »
2012-06-05 v1
598 }
8413aff2 »
2012-07-31 Uploading:
599
0a0ca28b »
2012-07-30 Weekend updates:
600 /** Admin Methods *********************************************************/
601
602 /**
603 * Register the metabox with the supporting post-type
604 *
605 * @param string $post_type
606 */
607 public static function add_meta_box( $post_type ) {
608
609 // Bail if not supported
610 if ( ! post_type_supports( $post_type, self::key ) )
611 return;
8ff4206e »
2012-06-05 v1
612
0a0ca28b »
2012-07-30 Weekend updates:
613 add_meta_box( self::key, __( 'Liveblog', 'liveblog' ), array( __CLASS__, 'display_meta_box' ) );
8ff4206e »
2012-06-05 v1
614 }
cd6d5741 »
2012-07-26 * Code clean up.
615
0a0ca28b »
2012-07-30 Weekend updates:
616 /**
617 * Output the metabox
618 *
619 * @param WP_Post $post
620 */
621 public static function display_meta_box( $post ) {
ea5a8a60 »
2012-12-18 Introduce archiving
622 $current_state = self::get_liveblog_state( $post->ID );
623 $buttons = array(
8c3cdd8d »
2012-12-20 Remove the Disable button
624 'enable' => array( 'value' => 'enable', 'text' => __( 'Enable', 'liveblog' ),
625 '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 &rarr;</a>', 'liveblog' ), get_permalink( $post ) ), 'primary' => true, 'disabled' => false, ),
ea5a8a60 »
2012-12-18 Introduce archiving
626 'archive' => array( 'value' => 'archive', 'text' => __( 'Archive', 'liveblog' ),
8c3cdd8d »
2012-12-20 Remove the Disable button
627 '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 &rarr;</a>', 'liveblog' ), get_permalink( $post ) ), 'primary' => false, 'disabled' => false ),
ea5a8a60 »
2012-12-18 Introduce archiving
628 );
8c3cdd8d »
2012-12-20 Remove the Disable button
629 if ( $current_state ) {
630 $active_text = $buttons[$current_state]['active-text'];
631 $buttons[$current_state]['disabled'] = true;
632 } else {
633 $active_text = __( 'This is a normal WordPress post, without a liveblog.', 'liveblog' );
634 $buttons['archive']['disabled'] = true;
ea5a8a60 »
2012-12-18 Introduce archiving
635 }
636 echo self::get_template_part( 'meta_box.php', compact( 'active_text', 'buttons' ) );
8ff4206e »
2012-06-05 v1
637 }
0a0ca28b »
2012-07-30 Weekend updates:
638
ea5a8a60 »
2012-12-18 Introduce archiving
639 public function admin_ajax_set_liveblog_state_for_post() {
640 $post_id = isset( $_REQUEST['post_id'] )? $_REQUEST['post_id'] : 0;
641 $new_state = isset( $_REQUEST['state'] )? $_REQUEST['state'] : '';
0a0ca28b »
2012-07-30 Weekend updates:
642
e447a3c5 »
2012-12-20 Check for permissions and nonces
643 self::ajax_current_user_can_edit_liveblog();
644 self::ajax_check_nonce();
8ff4206e »
2012-06-05 v1
645
ea5a8a60 »
2012-12-18 Introduce archiving
646 if ( !$REQUEST = get_post( $post_id ) ) {
feecd6bc »
2012-12-19 Add text domains
647 self::send_user_error( __( "Non-existing post ID: $post_id" , 'liveblog') );
ea5a8a60 »
2012-12-18 Introduce archiving
648 }
649
650 if ( wp_is_post_revision( $post_id ) ) {
feecd6bc »
2012-12-19 Add text domains
651 self::send_user_error( __( "The post is a revision: $post_id" , 'liveblog') );
ea5a8a60 »
2012-12-18 Introduce archiving
652 }
c9f98b5b »
2012-09-25 Only update/delete liveblog postmeta when it's changing.
653
ea5a8a60 »
2012-12-18 Introduce archiving
654 self::set_liveblog_state( $post_id, $_REQUEST['state'] );
655 self::display_meta_box( $REQUEST );
656 exit;
657 }
c9f98b5b »
2012-09-25 Only update/delete liveblog postmeta when it's changing.
658
ea5a8a60 »
2012-12-18 Introduce archiving
659 private function set_liveblog_state( $post_id, $state ) {
660 if ( in_array( $state, array( 'enable', 'archive' ) ) ) {
661 update_post_meta( $post_id, self::key, $state );
662 do_action( "liveblog_{$state}_post", $post_id );
663 } elseif ( 'disable' == $state ) {
8ff4206e »
2012-06-05 v1
664 delete_post_meta( $post_id, self::key );
7e39692c »
2012-09-25 Introduce some new hooks.
665 do_action( 'liveblog_disable_post', $post_id );
ea5a8a60 »
2012-12-18 Introduce archiving
666 } else {
667 return false;
7e39692c »
2012-09-25 Introduce some new hooks.
668 }
8ff4206e »
2012-06-05 v1
669 }
2ba7f864 »
2012-06-19 Remove trailing whitespace
670
0a0ca28b »
2012-07-30 Weekend updates:
671 /** Error Methods *********************************************************/
672
673 /**
674 * Can the current user edit liveblog data (non-ajax)
675 *
676 * @return bool
677 */
678 public static function current_user_can_edit_liveblog() {
679 return (bool) current_user_can( apply_filters( 'liveblog_edit_cap', self::edit_cap ) );
8ff4206e »
2012-06-05 v1
680 }
681
0a0ca28b »
2012-07-30 Weekend updates:
682 /**
683 * Can the current user edit liveblog data (ajax)
684 *
685 * Sends an error if not
686 */
687 public static function ajax_current_user_can_edit_liveblog() {
b58c3a07 »
2012-07-04 Remove leading underscores from function names
688 if ( ! self::current_user_can_edit_liveblog() ) {
69f9cbb2 »
2012-08-20 Add more specific HTTP error codes
689 self::send_forbidden_error( __( "Cheatin', uh?", 'liveblog' ) );
8ff4206e »
2012-06-05 v1
690 }
691 }
692
0a0ca28b »
2012-07-30 Weekend updates:
693 /**
694 * Check for valid intention, and send an error if there is none
695 *
696 * @param string $action
697 */
698 public static function ajax_check_nonce( $action = self::nonce_key ) {
8ff4206e »
2012-06-05 v1
699 if ( ! isset( $_REQUEST[ self::nonce_key ] ) || ! wp_verify_nonce( $_REQUEST[ self::nonce_key ], $action ) ) {
69f9cbb2 »
2012-08-20 Add more specific HTTP error codes
700 self::send_forbidden_error( __( 'Sorry, we could not authenticate you.', 'liveblog' ) );
8ff4206e »
2012-06-05 v1
701 }
702 }
703
0a0ca28b »
2012-07-30 Weekend updates:
704 /** Feedback **************************************************************/
705
706 /**
707 * Send an error message
708 * @param type $message
709 */
69f9cbb2 »
2012-08-20 Add more specific HTTP error codes
710 private static function send_server_error( $message ) {
0a0ca28b »
2012-07-30 Weekend updates:
711 self::status_header_with_message( 500, $message );
712 exit();
713 }
714
69f9cbb2 »
2012-08-20 Add more specific HTTP error codes
715 private static function send_user_error( $message ) {
716 self::status_header_with_message( 406, $message );
717 exit();
718 }
719
720 private static function send_forbidden_error( $message ) {
721 self::status_header_with_message( 403, $message );
722 exit();
723 }
724
0a0ca28b »
2012-07-30 Weekend updates:
725 /**
726 * Encode some data and echo it (possibly without cached headers)
727 *
728 * @param array $data
729 */
730 private static function json_return( $data ) {
20c5b025 »
2012-07-11 Get rid of the intermediate layer completely
731 $json_data = json_encode( $data );
8ff4206e »
2012-06-05 v1
732
f2908dfd »
2012-07-02 Get rid if return functionality in json_return()
733 header( 'Content-Type: application/json' );
cd6d5741 »
2012-07-26 * Code clean up.
734 if ( self::$do_not_cache_response )
6c667576 »
2012-07-04 Do not let the client cache future requests
735 nocache_headers();
20c5b025 »
2012-07-11 Get rid of the intermediate layer completely
736
737 echo $json_data;
0a0ca28b »
2012-07-30 Weekend updates:
738 exit();
d81e042f »
2012-07-11 Extract sending errors in its own method
739 }
740
0a0ca28b »
2012-07-30 Weekend updates:
741 /**
742 * Modify the header and description in the global array
743 *
744 * @global array $wp_header_to_desc
745 * @param int $status
746 * @param string $message
747 */
748 private static function status_header_with_message( $status, $message ) {
25323979 »
2012-07-11 Send HTTP errors instead of the success flag
749 global $wp_header_to_desc;
cd6d5741 »
2012-07-26 * Code clean up.
750
751 $status = absint( $status );
752 $official_message = isset( $wp_header_to_desc[$status] ) ? $wp_header_to_desc[$status] : '';
25323979 »
2012-07-11 Send HTTP errors instead of the success flag
753 $wp_header_to_desc[$status] = $message;
cd6d5741 »
2012-07-26 * Code clean up.
754
25323979 »
2012-07-11 Send HTTP errors instead of the success flag
755 status_header( $status );
cd6d5741 »
2012-07-26 * Code clean up.
756
25323979 »
2012-07-11 Send HTTP errors instead of the success flag
757 $wp_header_to_desc[$status] = $official_message;
758 }
8413aff2 »
2012-07-31 Uploading:
759
760 /** Plupload Helpers ******************************************************/
761
762 /**
763 * Convert hours to bytes
764 *
765 * @param unknown_type $size
766 * @return unknown
767 */
768 private static function convert_hr_to_bytes( $size ) {
769 $size = strtolower( $size );
770 $bytes = (int) $size;
771
772 if ( strpos( $size, 'k' ) !== false )
773 $bytes = intval( $size ) * 1024;
774 elseif ( strpos( $size, 'm' ) !== false )
775 $bytes = intval( $size ) * 1024 * 1024;
776 elseif ( strpos( $size, 'g' ) !== false )
777 $bytes = intval( $size ) * 1024 * 1024 * 1024;
778
779 return $bytes;
780 }
781
782 /**
783 * Convert bytes to hour
784 *
785 * @param string $bytes
786 * @return string
787 */
788 private static function convert_bytes_to_hr( $bytes ) {
789 $units = array( 0 => 'B', 1 => 'kB', 2 => 'MB', 3 => 'GB' );
790 $log = log( $bytes, 1024 );
791 $power = (int) $log;
792 $size = pow( 1024, $log - $power );
793
794 return $size . $units[$power];
795 }
796
797 /**
798 * Get the maximum upload file size
799 *
800 * @see wp_max_upload_size()
801 * @return string
802 */
803 private static function max_upload_size() {
804 $u_bytes = self::convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) );
805 $p_bytes = self::convert_hr_to_bytes( ini_get( 'post_max_size' ) );
806 $bytes = apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
807
808 return $bytes;
a6429c8f »
2012-08-15 Remove trailing whitespace
809 }
8ff4206e »
2012-06-05 v1
810 }
811
0a0ca28b »
2012-07-30 Weekend updates:
812 /**
813 * Load the one true WPCOM_Liveblog instance
814 *
815 * Loaded late on the 'plugins_loaded' hook to allow any other plugin to sneak
816 * in ahead of it, to add actions, filters, etc...
817 *
818 * @uses WPCOM_Liveblog::load()
819 */
820 function wpcom_liveblog_load() {
821 WPCOM_Liveblog::load();
822 }
823 add_action( 'plugins_loaded', 'wpcom_liveblog_load', 999 );
824
8ff4206e »
2012-06-05 v1
825 endif;
Something went wrong with that request. Please try again.