This repository has been archived by the owner on Nov 28, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
class_commentpress_display.php
3065 lines (1901 loc) · 67.1 KB
/
class_commentpress_display.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 /*
===============================================================
Class CommentPressDisplay Version 1.0
===============================================================
AUTHOR : Christian Wach <[email protected]>
---------------------------------------------------------------
NOTES
=====
---------------------------------------------------------------
*/
/*
===============================================================
Class Name
===============================================================
*/
class CommentPressDisplay {
/*
===============================================================
Properties
===============================================================
*/
// parent object reference
var $parent_obj;
// standard mobile browser
var $is_mobile = false;
// touch-based mobile browser
var $is_mobile_touch = false;
// touch-based tablet browser
var $is_tablet = false;
/**
* @description: initialises this object
* @param object $parent_obj a reference to the parent object
* @return object
* @todo:
*
*/
function __construct( $parent_obj ) {
// store reference to parent
$this->parent_obj = $parent_obj;
// init
$this->_init();
// --<
return $this;
}
/**
* @description: PHP 4 constructor
*/
function CommentPressDisplay( $parent_obj ) {
// is this php5?
if ( version_compare( PHP_VERSION, "5.0.0", "<" ) ) {
// call php5 constructor
$this->__construct( $parent_obj );
}
// --<
return $this;
}
/**
* @description: if needed, sets up this object
* @param integer $blog_id the ID of the blog - default null
* @todo: work out how to assess whether the theme needs activating and how to upgrade.
* more urgently: ONLY activate theme if not called from CP for Multisite until
* that plugin is updated NOT to activate the theme.
*
*/
function activate( $blog_id = null ) {
// get all themes
if ( function_exists( 'wp_get_themes' ) ) {
// get Commentpress theme by default, but allow overrides
$target_theme = apply_filters(
'cp_groupblog_theme_slug',
'commentpress'
);
// get the theme we want
$theme = wp_get_theme( $target_theme );
// if we get it...
if ( $theme->exists() AND $theme->is_allowed() ) {
// activate it
switch_theme(
$theme->get_template(),
$theme->get_stylesheet()
);
}
} else {
// use pre-3.4 logic
$themes = get_themes();
//print_r( $themes ); die();
// get Commentpress theme by default, but allow overrides
// NB, the key prior to WP 3.4 is the theme's *name*
$target_theme = apply_filters(
'cp_forced_theme_name',
'Commentpress'
);
// the key is the theme name
if ( isset( $themes[ $target_theme ] ) ) {
// activate it
switch_theme(
$themes[ $target_theme ]['Template'],
$themes[ $target_theme ]['Stylesheet']
);
}
}
}
/**
* @description: if needed, destroys this object
* @todo:
*
*/
function deactivate() {
// switch to default theme
switch_theme( WP_DEFAULT_THEME, WP_DEFAULT_THEME );
}
//#################################################################
/*
===============================================================
PUBLIC METHODS
===============================================================
*/
/**
* @description: enqueue jQuery, jQuery UI and plugins
* @todo:
*
*/
function get_jquery() {
// default to minified scripts
$debug_state = '';
// target different scripts when debugging
if ( defined( 'SCRIPT_DEBUG' ) AND SCRIPT_DEBUG === true ) {
// use uncompressed scripts
$debug_state = '.dev';
}
// add our javascript plugin and dependencies
wp_enqueue_script(
'jquery_commentpress',
plugins_url( 'js/jquery/plugins/jquery.commentpress'.$debug_state.'.js', CP_PLUGIN_FILE ),
array('jquery','jquery-form','jquery-ui-core','jquery-ui-resizable')
);
// add jQuery Scroll-To plugin
wp_enqueue_script(
'jquery_scrollto',
plugins_url( 'js/jquery/plugins/jquery.scrollTo.js', CP_PLUGIN_FILE ),
array('jquery_commentpress')
);
// add jQuery Cookie plugin
wp_enqueue_script(
'jquery_cookie',
plugins_url( 'js/jquery/plugins/jquery.cookie.js', CP_PLUGIN_FILE ),
array('jquery_commentpress')
);
/*
Prior to WP3.2 (IIRC), jQuery UI has to be added separately, as the built in one was not
sufficiently up-to-date. This is no longer the case, so the independent jQuery UI package
has been removed from Commentpress in favour of the built-in one.
*/
}
/**
* @description: enqueue our quicktags script
* @todo:
*
*/
function get_custom_quicktags() {
// don't bother if the current user lacks permissions
if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
return;
}
// need access to WP version
global $wp_version;
// there's a new quicktags script in 3.3
if ( version_compare( $wp_version, '3.2.99999', '>=' ) ) {
// add our javascript script and dependencies
wp_enqueue_script(
'cp_custom_quicktags',
plugin_dir_url( CP_PLUGIN_FILE ) . 'js/cp_quicktags_3.3.js',
array('quicktags'),
NULL, // no version
true // in footer
);
} else {
// add our javascript script and dependencies
wp_enqueue_script(
'cp_custom_quicktags',
plugin_dir_url( CP_PLUGIN_FILE ) . 'js/cp_quicktags.js',
array('quicktags'),
NULL, // no version
false // not in footer (but may need to be in WP 3.3)
);
}
}
/**
* @description: get admin stylesheet
* @return string $styles
* @todo:
*
*/
function get_admin_style() {
// init
$styles = '';
// construct path to admin.css
$filepath = get_template_directory() . '/style/css/admin.css';
// is our stylesheet present?
if ( file_exists( $filepath ) ) {
// add Admin UI stylesheet
$styles = '<!-- Commentpress Admin styles -->
<link rel="stylesheet" type="text/css" media="screen" href="'.get_template_directory_uri().'/style/css/admin.css" />
'."\n\n";
}
// --<
return $styles;
}
/**
* @description: get plugin stylesheets
* @return string $styles
* @todo:
*
*/
function get_frontend_styles() {
// add jQuery UI stylesheet -> needed for resizable columns
wp_enqueue_style(
'jquery.ui.base',
plugins_url( 'js/jquery/theme/jquery.ui.css', CP_PLUGIN_FILE )
);
}
/**
* @description: test if TinyMCE is allowed
* @return boolean $allowed
* @todo:
*
*/
function is_tinymce_allowed() {
// check option
if (
$this->parent_obj->db->option_exists( 'cp_comment_editor' ) AND
$this->parent_obj->db->option_get( 'cp_comment_editor' ) != '1'
) {
// --<
return false;
}
// don't return TinyMCE for touchscreens, mobile phones or tablets
if ( $this->is_mobile_touch OR $this->is_mobile OR $this->is_tablet ) {
// --<
return false;
}
// --<
return true;
}
/**
* @description: get built-in TinyMCE scripts from Wordpress Includes directory
* @return string $scripts
* @todo:
*
*/
function get_tinymce() {
// check if we can
if ( !$this->is_tinymce_allowed() ) {
// --<
return;
}
// test for wp_editor()
if ( function_exists( 'wp_editor' ) ) {
// don't include anything - this will be done in the comment form template
return;
} else {
// test for WordPress version
global $wp_version;
// for WP 3.2+
if ( version_compare( $wp_version, '3.2', '>=' ) ) {
// don't need settings
$this->_get_tinymce();
} else {
// get site HTTP root
$site_http_root = trailingslashit( get_bloginfo('wpurl') );
// all TinyMCE scripts
$scripts .= '<!-- TinyMCE -->
<script type="text/javascript" src="'.$site_http_root.'wp-includes/js/tinymce/tiny_mce.js"></script>
<script type="text/javascript" src="'.$site_http_root.'wp-includes/js/tinymce/langs/wp-langs-en.js?ver=20081129"></script>
'."\n";
// add our init
$scripts .= $this->_get_tinymce_init();
// out to browser
echo $scripts;
}
}
}
/**
* @description: get javascript for the plugin, context dependent
* @return string $script
* @todo:
*
*/
function get_javascript() {
// base url for the Commentpress parent theme
$_base = trailingslashit( get_template_directory_uri() );
// test whether we can find the scripts (ie, is this a true CP theme?)
$common = locate_template( array( 'style/js/cp_js_common.js' ), false );
// well?
if ( $common AND file_exists( $common ) ) {
// default to minified scripts
$debug_state = '';
// target different scripts when debugging
if ( defined( 'SCRIPT_DEBUG' ) AND SCRIPT_DEBUG === true ) {
// use uncompressed scripts
$debug_state = '.dev';
}
// enqueue common js
wp_enqueue_script(
'cp_common',
$_base.'style/js/cp_js_common'.$debug_state.'.js',
array('jquery_commentpress')
);
// test for buddypress special page
if ( $this->parent_obj->is_buddypress() AND $this->parent_obj->is_buddypress_special_page() ) {
// skip custom addComment
} else {
// enqueue form js
wp_enqueue_script(
'cp_form',
$_base.'style/js/cp_js_form'.$debug_state.'.js',
array('cp_common')
);
}
// test for commentpress special page
if ( $this->parent_obj->db->is_special_page() ) {
// enqueue accordion-like js
wp_enqueue_script(
'cp_special',
$_base.'style/js/cp_js_all_comments.js',
array('cp_form')
);
}
// is this a CPT?
//$current_type = get_post_type();
//print_r( $current_type ); die();
// get vars
$vars = $this->parent_obj->db->get_javascript_vars();
// get vars
$this->localise_js( $vars, 'cp_common' );
}
}
/**
* @description: get help text
* @return HTML $help
* @todo: translation
*
*/
function get_help() {
$help = <<<HELPTEXT
<p>For further information about using Commentpress, please refer to the <a href="http://www.futureofthebook.org/commentpress/support/">Commentpress support pages</a> or use one of the links below:</p>
<ul>
<li><a href="http://www.futureofthebook.org/commentpress/support/structuring-your-document/">Structuring your Document</a></li>
<li><a href="http://www.futureofthebook.org/commentpress/support/formatting-your-document/">Formatting Your Document</a></li>
<li><a href="http://www.futureofthebook.org/commentpress/support/using-commentpress/">How to read a Commentpress document</a></li>
</ul>
HELPTEXT;
// --<
return $help;
}
/**
* @description: construct a javascript for inclusion in the HTML of the page
* @param array $vars array of variables and their values
* @param string $comment description for reference
* @return string $js
* @todo:
*
*/
function localise_js( $vars = array(), $script_ref ) {
// use wp function
wp_localize_script( $script_ref, 'CommentpressSettings', $vars );
}
/**
* @description: show the posts and their comment count in a list format
* @todo:
*
*/
function list_posts( $params = 'numberposts=-1&order=DESC' ) {
// get all posts
$posts = get_posts( $params );
// have we set the option?
$list_style = $this->parent_obj->db->option_get('cp_show_extended_toc');
//print_r( $list_style ); die();
// if not set or set to 'off'
if ( $list_style === false OR $list_style == '0' ) {
// --------------------------
// old-style undecorated list
// --------------------------
// run through them...
foreach( $posts AS $item ) {
// get comment count for that post
$count = count( $this->parent_obj->db->get_approved_comments( $item->ID ) );
// write list item
echo '<li class="title"><a href="'.get_permalink( $item->ID ).'">'.get_the_title( $item->ID ).' ('.$count.')</a></li>'."\n";
}
} else {
// ------------------------
// new-style decorated list
// ------------------------
// run through them...
foreach( $posts AS $item ) {
// init output
$_html = '';
//print_r( $item ); die();
//setup_postdata( $item );
// get comment count for that post
$count = count( $this->parent_obj->db->get_approved_comments( $item->ID ) );
// compat with Co-Authors Plus
if ( function_exists( 'get_coauthors' ) ) {
// get multiple authors
$authors = get_coauthors( $item->ID );
//print_r( $authors ); die();
// if we get some
if ( !empty( $authors ) ) {
// use the Co-Authors format of "name, name, name & name"
$author_html = '';
// init counter
$n = 1;
// find out how many author we have
$author_count = count( $authors );
// loop
foreach( $authors AS $author ) {
// default to comma
$sep = ', ';
// if we're on the penultimate
if ( $n == ($author_count - 1) ) {
// use ampersand
$sep = __( ' & ', 'commentpress-theme' );
}
// if we're on the last, don't add
if ( $n == $author_count ) { $sep = ''; }
// get name
$author_html .= $this->echo_post_author( $author->ID, false );
// and separator
$author_html .= $sep;
// increment
$n++;
// are we showing avatars?
if ( get_option( 'show_avatars' ) ) {
// get avatar
$_html .= get_avatar( $author->ID, $size='32' );
}
}
// add citation
$_html .= '<cite class="fn">'.$author_html.'</cite>'."\n";
// add permalink
$_html .= '<p class="post_activity_date">'.get_the_time('l, F jS, Y', $item->ID).'</p>'."\n";
}
} else {
// get avatar
$author_id = $item->post_author;
// are we showing avatars?
if ( get_option( 'show_avatars' ) ) {
$_html .= get_avatar( $author_id, $size='32' );
}
// add citation
$_html .= '<cite class="fn">'.$this->echo_post_author( $author_id, false ).'</cite>';
// add permalink
$_html .= '<p class="post_activity_date">'.get_the_time('l, F jS, Y', $item->ID).'</p>';
}
// write list item
echo '<li class="title">
<div class="post-identifier">
'.$_html.'
</div>
<a href="'.get_permalink( $item->ID ).'" class="post_activity_link">'.get_the_title( $item->ID ).' ('.$count.')</a>
</li>'."\n";
}
}
}
/**
* @description: show username (with link)
* @todo: remove from theme functions.php?
*
*/
function echo_post_author( $author_id, $echo = true ) {
// get author details
$user = get_userdata( $author_id );
// kick out if we don't have a user with that ID
if ( !is_object( $user ) ) { return; }
// access plugin
global $commentpress_obj, $post;
// if we have the plugin enabled and it's BP
if ( is_object( $post ) AND is_object( $commentpress_obj ) AND $commentpress_obj->is_buddypress() ) {
// construct user link
$author = bp_core_get_userlink( $user->ID );
} else {
// link to theme's author page
$link = sprintf(
'<a href="%1$s" title="%2$s" rel="author">%3$s</a>',
get_author_posts_url( $user->ID, $user->user_nicename ),
esc_attr( sprintf( __( 'Posts by %s' ), $user->display_name ) ),
esc_html( $user->display_name )
);
$author = apply_filters( 'the_author_posts_link', $link );
}
// if we're echoing
if ( $echo ) {
echo $author;
} else {
return $author;
}
}
/**
* @description: print the posts and their comment count in a list format
* @todo:
*
*/
function list_pages() {
/*
Question: do we want to use WP menus? And if so, how?
Currently, we're using wp_list_pages(), so let's try wp_page_menu() first
// If we set the theme to use wp_nav_menu(), we need to register it
register_nav_menu( 'primary', __( 'Primary Menu', 'twentyeleven' ) );
Our navigation menu. If one isn't filled out, wp_nav_menu falls back to
wp_page_menu. The menu assiged to the primary position is the one used. If
none is assigned, the menu with the lowest ID is used.
//wp_nav_menu( array( 'theme_location' => 'primary' ) );
// set list pages defaults
$args = array(
'sort_column' => 'menu_order, post_title',
'menu_class' => 'menu',
'include' => '',
'exclude' => '',
'echo' => true,
'show_home' => false,
'link_before' => '',
'link_after' => ''
);
*/
// test for custom menu
if ( has_nav_menu( 'toc' ) ) {
// try and use it
wp_nav_menu( array(
'theme_location' => 'toc',
'echo' => true,
'container' => '',
'items_wrap' => '%3$s',
) );
return;
}
// get welcome page ID
$welcome_id = $this->parent_obj->db->option_get( 'cp_welcome_page' );
// get front page
$page_on_front = $this->parent_obj->db->option_wp_get( 'page_on_front' );
// print link to title page, if we have one and it's the front page
if ( $welcome_id !== false AND $page_on_front == $welcome_id ) {
// define title page
$title_page_title = get_the_title( $welcome_id );
// allow overrides
$title_page_title = apply_filters( 'cp_title_page_title', $title_page_title );
// echo list item
echo '<li class="page_item page-item-'.$welcome_id.'"><a href="'.get_permalink( $welcome_id ).'">'.$title_page_title.'</a></li>';
}
// get page display option
//$depth = $this->parent_obj->db->option_get('cp_show_subpages');
// ALWAYS write subpages into page, even if they aren't displayed
$depth = 0;
// get pages to exclude
$exclude = $this->parent_obj->db->option_get('cp_special_pages');
// do we have any?
if ( !$exclude ) { $exclude = array(); }
// exclude title page, if we have one
if ( $welcome_id !== false ) { $exclude[] = $welcome_id; }
// set list pages defaults
$defaults = array(
'depth' => $depth,
'show_date' => '',
'date_format' => $this->parent_obj->db->option_get('date_format'),
'child_of' => 0,
'exclude' => implode( ',', $exclude ),
'title_li' => '',
'echo' => 1,
'authors' => '',
'sort_column' => 'menu_order, post_title',
'link_before' => '',
'link_after' => '',
'exclude_tree' => ''
);
// use Wordpress function to echo
wp_list_pages( $defaults );
/*
// The following code manually lists pages, but adds the comment count to the name
// init params
$params = 'sort_column=menu_order';
// exclude the special pages
$params .= '&exclude='.implode( ',', $special );
//echo $params; exit();
// get all pages
$_pages = get_pages( $params );
// run through them...
foreach( $_pages AS $_page ) {
// get comment count for that page
$count = count( $this->parent_obj->db->get_approved_comments( $_page->ID ) );
// write list item
echo '<li class="title"><a href="'.get_page_link( $_page->ID ).'">'.$_page->post_title.' ('.$count.')</a></li>'."\n";
}
*/
}
/**
* @description: get the block icons
* @param integer $comment_count number of comments
* @param string $text_signature comment text signature
* @param string $block_type either 'auto', 'line' or 'block'
* @param integer $para_num sequnetial commentable block number
* @return string $comment_icon
* @todo:
*
*/