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.php
2698 lines (1529 loc) · 47.1 KB
/
class_commentpress.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 CommentPress Version 1.0
===============================================================
AUTHOR : Christian Wach <[email protected]>
---------------------------------------------------------------
NOTES
=====
---------------------------------------------------------------
*/
/*
===============================================================
Class Name
===============================================================
*/
class CommentPress {
/*
===============================================================
Properties
===============================================================
*/
// database object
var $db;
// display object
var $display;
// nav object
var $nav;
// parser object
var $parser;
// options page
var $options_page;
// buddypress present
var $buddypress = false;
// bp-groupblog present
var $bp_groupblog = false;
/**
* @description: initialises this object
* @return object
* @todo:
*
*/
function __construct() {
// init
$this->_init();
// --<
return $this;
}
/**
* PHP 4 constructor
*/
function CommentPress() {
// is this php5?
if ( version_compare( PHP_VERSION, "5.0.0", "<" ) ) {
// call php5 constructor
$this->__construct();
}
// --<
return $this;
}
/**
* @description: if needed, destroys this object
* @todo:
*
*/
function destroy() {
// nothing
}
//#################################################################
/*
===============================================================
PUBLIC METHODS
===============================================================
*/
/**
* @description: runs when plugin is activated
* @param integer $blog_id the ID of the blog - default null
* @todo:
*
*/
function activate( $blog_id = null ) {
// initialise display - sets the theme
$this->display->activate( $blog_id );
// initialise database
$this->db->activate( $blog_id );
}
/**
* @description: runs when plugin is deactivated
* @todo: do we want to remove all traces of the plugin?
*
*/
function deactivate() {
// call database destroy method
$this->db->deactivate();
// call display destroy method
$this->display->deactivate();
}
/**
* @description: runs when plugin is uninstalled
* @todo: do we want to remove all traces of the plugin?
*
*/
function uninstall() {
/*
// call database destroy method
$this->db->uninstall();
// call display destroy method
$this->display->uninstall();
*/
}
/**
* @description: loads translation, if present
* @todo:
*
*/
function translation() {
// only use, if we have it...
if( function_exists('load_plugin_textdomain') ) {
// not used, as there are no translations as yet
load_plugin_textdomain(
// unique name
'commentpress-plugin',
// deprecated argument
false,
// relative path to directory containing translation files
dirname( plugin_basename( CP_PLUGIN_FILE ) ) . '/languages/'
);
}
}
/**
* @description: called when BuddyPress is active
* @todo:
*
*/
function buddypress_init() {
// we've got BuddyPress installed
$this->buddypress = true;
}
/**
* @description: configure when BuddyPress is loaded
* @todo:
*
*/
function buddypress_globals_loaded() {
// for bp-groupblog integration...
if (
// require multisite
is_multisite()
// and groups
AND bp_is_active( 'groups' )
// and bp-groupblog
AND defined( 'BP_GROUPBLOG_IS_INSTALLED' )
) {
// check if this blog is a group blog...
$group_id = get_groupblog_group_id( get_current_blog_id() );
if ( is_numeric( $group_id ) ) {
// okay, we're properly configured
$this->bp_groupblog = true;
}
}
}
/**
* @description: is BuddyPress active?
* @todo:
*
*/
function is_buddypress() {
// --<
return $this->buddypress;
}
/**
* @description: is this a BuddyPress Group Blog?
* @todo:
*
*/
function is_groupblog() {
// --<
return $this->bp_groupblog;
}
/**
* @description: is this a BuddyPress "special page" - a component homepage?
* @todo:
*
*/
function is_buddypress_special_page() {
// kick out if not BP
if ( !$this->is_buddypress() ) {
return false;
}
// let's see...
return !bp_is_blog_page();
}
/**
* @description: utility to add link to settings page
* @todo:
*
*/
function plugin_action_links( $links, $file ) {
if ( $file == CP_PLUGIN_FILE ) {
$links[] = '<a href="options-general.php?page=cp_admin_page">'.__( 'Settings', 'commentpress-plugin' ).'</a>';
}
return $links;
}
/**
* @description: utility to add a message to admin pages when upgrade required
* @todo:
*
*/
function admin_upgrade_alert() {
// sanity check function exists
if ( function_exists('current_user_can') ) {
// check user permissions
if ( current_user_can('manage_options') ) {
// show it
echo '<div id="message" class="error"><p>'.__( 'Commentpress has been updated. Please visit the ' ).'<a href="options-general.php?page=cp_admin_page">'.__( 'Settings Page', 'commentpress-plugin' ).'</a>.</p></div>';
}
}
}
/**
* @description: appends option to admin menu
* @todo:
*
*/
function admin_menu() {
// sanity check function exists
if ( function_exists('current_user_can') ) {
// check user permissions
if ( current_user_can('manage_options') ) {
// try and update options
$saved = $this->db->options_update();
// if upgrade required...
if ( $this->db->check_upgrade() ) {
// access globals
global $pagenow;
// show on pages other than the CP admin page
if (
$pagenow == 'options-general.php'
AND !empty( $_GET['page'] )
AND 'cp_admin_page' == $_GET['page']
) {
// we're on our admin page
} else {
// show message
add_action( 'admin_notices', array( &$this, 'admin_upgrade_alert' ) );
}
}
// insert item in relevant menu
$this->options_page = add_options_page(
__( 'Commentpress Settings', 'commentpress-plugin' ),
__( 'Commentpress', 'commentpress-plugin' ),
'manage_options',
'cp_admin_page',
array( &$this, 'options_page' )
);
//print_r( $this->options_page );die();
// add scripts and styles
add_action( 'admin_print_scripts-'.$this->options_page, array( &$this, 'admin_js' ) );
add_action( 'admin_print_styles-'.$this->options_page, array( &$this, 'admin_css' ) );
add_action( 'admin_head-'.$this->options_page, array( &$this, 'admin_head' ), 50 );
}
}
}
/**
* @description: prints plugin options page header
* @todo:
*
*/
function admin_head() {
// get admin stylesheet
echo $this->display->get_admin_style();
// get admin javascript
echo $this->display->get_admin_js();
// there's a new screen object for help in 3.3
global $wp_version;
if ( version_compare( $wp_version, '3.2.99999', '>=' ) ) {
$screen = get_current_screen();
//print_r( $screen ); die();
// use method in this class
$this->options_help( &$screen );
}
// do we have a custom header bg colour?
if ( $this->db->option_get_header_bg() != $this->db->header_bg_colour ) {
// echo inline style
echo '
<style type="text/css">
#book_header {
background: #'.$this->db->option_get_header_bg().';
}
</style>
';
}
}
/**
* @description: queue plugin options page css
* @todo:
*
*/
function admin_css() {
// enqueue farbtastic
wp_enqueue_style('farbtastic');
}
/**
* @description: queue plugin options page javascript
* @todo:
*
*/
function admin_js() {
// enqueue farbtastic
wp_enqueue_script('farbtastic');
}
/**
* @description: prints plugin options page
* @todo:
*
*/
function options_page() {
// sanity check function exists
if ( function_exists( 'current_user_can' ) ) {
// check user permissions
if ( current_user_can( 'manage_options' ) ) {
// get our admin options page
echo $this->display->get_admin_page();
}
}
}
/**
* @description: add scripts needed across all WP admin pages
* @todo:
*
*/
function enqueue_admin_scripts() {
// add quicktag button to page editor
$this->display->get_custom_quicktags();
}
/**
* @description: adds script libraries
* @todo:
*
*/
function enqueue_scripts() {
// don't include in admin or wp-login.php
if ( is_admin() OR ( isset( $GLOBALS['pagenow'] ) AND 'wp-login.php' == $GLOBALS['pagenow'] ) ) {
return;
}
// add jQuery libraries
$this->display->get_jquery();
// if comments are enabled on this post/page
if ( $this->db->comments_enabled() ) {
// add tinyMCE scripts
$this->display->get_tinymce();
}
// add Table of Contents javascript files
$this->display->get_javascript();
}
/**
* @description: adds CSS
* @todo:
*
*/
function enqueue_styles() {
// add plugin styles
$this->display->get_frontend_styles();
}
/**
* @description: redirect to child page
* @todo:
*
*/
function redirect_to_child() {
// do redirect
$this->nav->redirect_to_child();
}
/**
* @description: inserts plugin-specific header items
* @param string $headers
* @return string $headers
* @todo:
*
*/
function head( $headers ) {
// do we have navigation?
if ( is_single() OR is_page() OR is_attachment() ) {
// initialise nav
$this->nav->initialise();
}
}
/**
* @description: parses page/post content
* @param string $content the content of the page/post
* @return string $content
* @todo:
*
*/
function the_content( $content ) {
// reference our post
global $post;
// compat with Subscribe to Comments Reloaded
if( $this->is_subscribe_to_comments_reloaded_page() ) {
// --<
return $content;
}
// compat with Theme My Login
if( $this->is_theme_my_login_page() ) {
// --<
return $content;
}
// test for buddypress special page (compat with BP Docs)
if ( $this->is_buddypress() ) {
// is it a component homepage?
if ( $this->is_buddypress_special_page() ) {
// --<
return $content;
}
}
// only parse posts or pages...
if( ( is_single() OR is_page() OR is_attachment() ) AND !$this->db->is_special_page() ) {
// delegate to parser
$content = $this->parser->the_content( $content );
}
// --<
return $content;
}
/**
* @description: retrieves option for displaying TOC
* @return mixed $result
* @todo:
*
*/
function get_list_option() {
// get list option flag
$result = $this->db->option_get( 'cp_show_posts_or_pages_in_toc' );
// --<
return $result;
}
/**
* @description: retrieves minimise all button
* @param: string $sidebar type of sidebar (comments, toc, activity)
* @return string $result HTML for minimise button
* @todo:
*
*/
function get_minimise_all_button( $sidebar = 'comments' ) {
// get minimise image
$result = $this->display->get_minimise_all_button( $sidebar );
// --<
return $result;
}
/**
* @description: retrieves header minimise button
* @return string $result HTML for minimise button
* @todo:
*
*/
function get_header_min_link() {
// get minimise image
$result = $this->display->get_header_min_link();
// --<
return $result;
}
/**
* @description: retrieves text_signature hidden input
* @return string $result HTML input
* @todo:
*
*/
function get_signature_field() {
// init text signature
$text_sig = '';
// get comment ID to reply to from URL query string
$reply_to_comment_id = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
// did we get a comment ID?
if ( $reply_to_comment_id != 0 ) {
// get paragraph text signature
$text_sig = $this->db->get_text_signature_by_comment_id( $reply_to_comment_id );
} else {
// do we have a paragraph number in the query string?
$reply_to_para_id = isset($_GET['replytopara']) ? (int) $_GET['replytopara'] : 0;
// did we get a comment ID?
if ( $reply_to_para_id != 0 ) {
// get paragraph text signature
$text_sig = $this->get_text_signature( $reply_to_para_id );
}
}
// get list option flag
$result = $this->display->get_signature_input( $text_sig );
// --<
return $result;
}
/**
* @description: intercepts media uploads looking for attachments to our title special page
* @param integer $attachment_ID the ID of the attachment
* @todo:
*
*/
function set_book_cover( $attachment_ID ) {
// if the attachment is to our title page, we assume that it
// is the "book" cover if we're in the CP.org context
/*
// get all image attachments to our title page
$attachments = get_children(
array(
'post_parent' => $this->db->option_get( 'cp_title_page' ),
'post_type' => 'attachment',
'post_mime_type' => 'image',
'orderby' => 'menu_order'
)
);
*/
}
/**
* @description: add reserved names
* @param array $reserved_names the existing list of illegal names
* @todo:
*
*/
function add_reserved_names( $reserved_names ) {
// get all image attachments to our title page
$reserved_names = array_merge(
$reserved_names,
array(
'title-page',
'general-comments',
'all-comments',
'comments-by-commenter',
'table-of-contents',
'author', // not currently used
'login', // for Theme My Login
)
);
// --<
return $reserved_names;
}
/**
* @description: add sidebar to signup form
* @todo:
*
*/
function after_signup_form() {
// add sidebar
get_sidebar();
}
/**
* @description: adds meta boxes to admin screens
* @todo:
*
*/
function add_meta_boxes() {
// add our meta boxes to pages
add_meta_box(