-
Notifications
You must be signed in to change notification settings - Fork 132
/
Copy pathuser-groups.php
1261 lines (1097 loc) · 45.8 KB
/
user-groups.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 EF_User_Groups
*
* @todo all of them PHPdocs
* @todo Resolve whether the notifications component of this class should be moved to "subscriptions"
* @todo Decide whether it's functional to store user_ids in the term description array
* - Argument against: it's going to be expensive to look up usergroups for a user
*
*/
if ( !class_exists( 'EF_User_Groups' ) ) {
class EF_User_Groups extends EF_Module {
var $module;
/**
* Keys for storing data
* - taxonomy_key - used for custom taxonomy
* - term_prefix - Used for custom taxonomy terms
*/
const taxonomy_key = 'ef_usergroup';
const term_prefix = 'ef-usergroup-';
var $manage_usergroups_cap = 'edit_usergroups';
/**
* Register the module with Edit Flow but don't do anything else
*
* @since 0.7
*/
function __construct( ) {
$this->module_url = $this->get_module_url( __FILE__ );
// Register the User Groups module with Edit Flow
$args = array(
'title' => __( 'User Groups', 'edit-flow' ),
'short_description' => __( 'Organize your users into groups to mimic your organizational structure.', 'edit-flow' ),
'extended_description' => __( 'Configure user groups to organize all of the users on your site. Each user can be in many user groups and you can change them at any time.', 'edit-flow' ),
'module_url' => $this->module_url,
'img_url' => $this->module_url . 'lib/usergroups_s128.png',
'slug' => 'user-groups',
'default_options' => array(
'enabled' => 'on',
'post_types' => array(
'post' => 'on',
'page' => 'off',
),
),
'messages' => array(
'usergroup-added' => __( "User group created. Feel free to add users to the usergroup.", 'edit-flow' ),
'usergroup-updated' => __( "User group updated.", 'edit-flow' ),
'usergroup-missing' => __( "User group doesn't exist.", 'edit-flow' ),
'usergroup-deleted' => __( "User group deleted.", 'edit-flow' ),
),
'configure_page_cb' => 'print_configure_view',
'configure_link_text' => __( 'Manage User Groups', 'edit-flow' ),
'autoload' => false,
'settings_help_tab' => array(
'id' => 'ef-user-groups-overview',
'title' => __('Overview', 'edit-flow'),
'content' => __('<p>For those with many people involved in the publishing process, user groups helps you keep them organized.</p><p>Currently, user groups are primarily used for subscribing a set of users to a post for notifications.</p>', 'edit-flow'),
),
'settings_help_sidebar' => __( '<p><strong>For more information:</strong></p><p><a href="http://editflow.org/features/user-groups/">User Groups Documentation</a></p><p><a href="http://wordpress.org/tags/edit-flow?forum_id=10">Edit Flow Forum</a></p><p><a href="https://github.com/danielbachhuber/Edit-Flow">Edit Flow on Github</a></p>', 'edit-flow' ),
);
$this->module = EditFlow()->register_module( 'user_groups', $args );
}
/**
* Module startup
*/
/**
* Initialize the rest of the stuff in the class if the module is active
*
* @since 0.7
*/
function init() {
// Register the objects where we'll be storing data and relationships
$this->register_usergroup_objects();
$this->manage_usergroups_cap = apply_filters( 'ef_manage_usergroups_cap', $this->manage_usergroups_cap );
// Register our settings
add_action( 'admin_init', array( $this, 'register_settings' ) );
// Handle any adding, editing or saving
add_action( 'admin_init', array( $this, 'handle_add_usergroup' ) );
add_action( 'admin_init', array( $this, 'handle_edit_usergroup' ) );
add_action( 'admin_init', array( $this, 'handle_delete_usergroup' ) );
add_action( 'wp_ajax_inline_save_usergroup', array( $this, 'handle_ajax_inline_save_usergroup' ) );
// Usergroups can be managed from the User profile view
add_action( 'show_user_profile', array( $this, 'user_profile_page' ) );
add_action( 'edit_user_profile', array( $this, 'user_profile_page' ) );
add_action( 'user_profile_update_errors', array( $this, 'user_profile_update' ), 10, 3 );
// Javascript and CSS if we need it
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) );
}
/**
* Load the capabilities onto users the first time the module is run
*
* @since 0.7
*/
function install() {
// Add necessary capabilities to allow management of user groups
$usergroup_roles = array(
'administrator' => array('edit_usergroups'),
);
foreach( $usergroup_roles as $role => $caps ) {
$this->add_caps_to_role( $role, $caps );
}
// Create our default usergroups
$default_usergroups = array(
array(
'name' => __( 'Copy Editors', 'edit-flow' ),
'description' => __( 'Making sure the quality is top-notch.', 'edit-flow' ),
),
array(
'name' => __( 'Photographers', 'edit-flow' ),
'description' => __( 'Capturing the story visually.', 'edit-flow' ),
),
array(
'name' => __( 'Reporters', 'edit-flow' ),
'description' => __( 'Out in the field, writing stories.', 'edit-flow' ),
),
array(
'name' => __( 'Section Editors', 'edit-flow' ),
'description' => __( 'Providing feedback and direction.', 'edit-flow' ),
),
);
foreach( $default_usergroups as $args ) {
$this->add_usergroup( $args );
}
}
/**
* Upgrade our data in case we need to
*
* @since 0.7
*/
function upgrade( $previous_version ) {
global $edit_flow;
// Upgrade path to v0.7
if ( version_compare( $previous_version, '0.7' , '<' ) ) {
global $wpdb;
// Set all of the user group terms to our new taxonomy
$wpdb->update( $wpdb->term_taxonomy, array( 'taxonomy' => self::taxonomy_key ), array( 'taxonomy' => 'following_usergroups' ) );
// Get all of the users who are a part of user groups and assign them to their new user group values
$query = "SELECT * FROM $wpdb->usermeta WHERE meta_key='wp_ef_usergroups';";
$usergroup_users = $wpdb->get_results( $query );
// Sort all of the users based on their usergroup(s)
$users_to_add = array();
foreach( (array)$usergroup_users as $usergroup_user ) {
if ( is_object( $usergroup_user ) )
$users_to_add[$usergroup_user->meta_value][] = (int)$usergroup_user->user_id;
}
// Add user IDs to each usergroup
foreach( $users_to_add as $usergroup_slug => $users_array ) {
$usergroup = $this->get_usergroup_by( 'slug', $usergroup_slug );
$this->add_users_to_usergroup( $users_array, $usergroup->term_id );
}
// Update the term slugs for each user group
$all_usergroups = $this->get_usergroups();
foreach( $all_usergroups as $usergroup ) {
$new_slug = str_replace( 'ef_', self::term_prefix, $usergroup->slug );
$this->update_usergroup( $usergroup->term_id, array( 'slug' => $new_slug ) );
}
// Delete all of the previous usermeta values
$wpdb->query( "DELETE FROM $wpdb->usermeta WHERE meta_key='wp_ef_usergroups';" );
// Technically we've run this code before so we don't want to auto-install new data
$edit_flow->update_module_option( $this->module->name, 'loaded_once', true );
}
// Upgrade path to v0.7.4
if ( version_compare( $previous_version, '0.7.4', '<' ) ) {
// Usergroup descriptions become base64_encoded, instead of maybe json_encoded.
$this->upgrade_074_term_descriptions( self::taxonomy_key );
}
}
/**
* Individual Usergroups are stored using a custom taxonomy
* Posts are associated with usergroups based on taxonomy relationship
* User associations are stored serialized in the term's description field
*
* @since 0.7
*
* @uses register_taxonomy()
*/
function register_usergroup_objects() {
// Load the currently supported post types so we only register against those
$supported_post_types = $this->get_post_types_for_module( $this->module );
// Use a taxonomy to manage relationships between posts and usergroups
$args = array(
'public' => false,
'rewrite' => false,
);
register_taxonomy( self::taxonomy_key, $supported_post_types, $args );
}
/**
* Enqueue necessary admin scripts
*
* @since 0.7
*
* @uses wp_enqueue_script()
*/
function enqueue_admin_scripts() {
if ( $this->is_whitelisted_functional_view() || $this->is_whitelisted_settings_view( $this->module->name ) ) {
wp_enqueue_script( 'jquery-listfilterizer' );
wp_enqueue_script( 'jquery-quicksearch' );
wp_enqueue_script( 'edit-flow-user-groups-js', $this->module_url . 'lib/user-groups.js', array( 'jquery', 'jquery-listfilterizer', 'jquery-quicksearch' ), EDIT_FLOW_VERSION, true );
}
if ( $this->is_whitelisted_settings_view( $this->module->name ) )
wp_enqueue_script( 'edit-flow-user-groups-configure-js', $this->module_url . 'lib/user-groups-configure.js', array( 'jquery' ), EDIT_FLOW_VERSION, true );
}
/**
* Enqueue necessary admin styles, but only on the proper pages
*
* @since 0.7
*
* @uses wp_enqueue_style()
*/
function enqueue_admin_styles() {
if ( $this->is_whitelisted_functional_view() || $this->is_whitelisted_settings_view() ) {
wp_enqueue_style( 'jquery-listfilterizer' );
wp_enqueue_style( 'edit-flow-user-groups-css', $this->module_url . 'lib/user-groups.css', false, EDIT_FLOW_VERSION );
}
}
/**
* Module ???
*/
/**
* Handles a POST request to add a new Usergroup. Redirects to edit view after
* for admin to add users to usergroup
* Hooked into 'admin_init' and kicks out right away if no action
*
* @since 0.7
*/
function handle_add_usergroup() {
if ( !isset( $_POST['submit'], $_POST['form-action'], $_GET['page'] )
|| $_GET['page'] != $this->module->settings_slug || $_POST['form-action'] != 'add-usergroup' )
return;
if ( !wp_verify_nonce( $_POST['_wpnonce'], 'add-usergroup' ) )
wp_die( $this->module->messages['nonce-failed'] );
if ( !current_user_can( $this->manage_usergroups_cap ) )
wp_die( $this->module->messages['invalid-permissions'] );
// Sanitize all of the user-entered values
$name = strip_tags( trim( $_POST['name'] ) );
$description = stripslashes( strip_tags( trim( $_POST['description'] ) ) );
$_REQUEST['form-errors'] = array();
/**
* Form validation for adding new Usergroup
*
* Details
* - 'name' is a required field, but can't match an existing name or slug. Needs to be 40 characters or less
* - "description" can accept a limited amount of HTML, and is optional
*/
// Field is required
if ( empty( $name ) )
$_REQUEST['form-errors']['name'] = __( 'Please enter a name for the user group.', 'edit-flow' );
// Check to ensure a term with the same name doesn't exist
if ( $this->get_usergroup_by( 'name', $name ) )
$_REQUEST['form-errors']['name'] = __( 'Name already in use. Please choose another.', 'edit-flow' );
// Check to ensure a term with the same slug doesn't exist
if ( $this->get_usergroup_by( 'slug', sanitize_title( $name ) ) )
$_REQUEST['form-errors']['name'] = __( 'Name conflicts with slug for another term. Please choose again.', 'edit-flow' );
if ( strlen( $name ) > 40 )
$_REQUEST['form-errors']['name'] = __( 'User group name cannot exceed 40 characters. Please try a shorter name.', 'edit-flow' );
// Kick out if there are any errors
if ( count( $_REQUEST['form-errors'] ) ) {
$_REQUEST['error'] = 'form-error';
return;
}
// Try to add the Usergroup
$args = array(
'name' => $name,
'description' => $description,
);
$usergroup = $this->add_usergroup( $args );
if ( is_wp_error( $usergroup ) )
wp_die( __( 'Error adding usergroup.', 'edit-flow' ) );
$args = array(
'action' => 'edit-usergroup',
'usergroup-id' => $usergroup->term_id,
'message' => 'usergroup-added'
);
$redirect_url = $this->get_link( $args );
wp_redirect( $redirect_url );
exit;
}
/**
* Handles a POST request to edit a Usergroup
* Hooked into 'admin_init' and kicks out right away if no action
*
* @since 0.7
*/
function handle_edit_usergroup() {
if ( !isset( $_POST['submit'], $_POST['form-action'], $_GET['page'] )
|| $_GET['page'] != $this->module->settings_slug || $_POST['form-action'] != 'edit-usergroup' )
return;
if ( !wp_verify_nonce( $_POST['_wpnonce'], 'edit-usergroup' ) )
wp_die( $this->module->messages['nonce-failed'] );
if ( !current_user_can( $this->manage_usergroups_cap ) )
wp_die( $this->module->messages['invalid-permissions'] );
if ( !$existing_usergroup = $this->get_usergroup_by( 'id', (int)$_POST['usergroup_id'] ) )
wp_die( $this->module->messages['usergroup-missing'] );
// Sanitize all of the user-entered values
$name = strip_tags( trim( $_POST['name'] ) );
$description = stripslashes( strip_tags( trim( $_POST['description'] ) ) );
$_REQUEST['form-errors'] = array();
/**
* Form validation for editing a Usergroup
*
* Details
* - 'name' is a required field, but can't match an existing name or slug. Needs to be 40 characters or less
* - "description" can accept a limited amount of HTML, and is optional
*/
// Field is required
if ( empty( $name ) )
$_REQUEST['form-errors']['name'] = __( 'Please enter a name for the user group.', 'edit-flow' );
// Check to ensure a term with the same name doesn't exist
$search_term = $this->get_usergroup_by( 'name', $name );
if ( is_object( $search_term ) && $search_term->term_id != $existing_usergroup->term_id )
$_REQUEST['form-errors']['name'] = __( 'Name already in use. Please choose another.', 'edit-flow' );
// Check to ensure a term with the same slug doesn't exist
$search_term = $this->get_usergroup_by( 'slug', sanitize_title( $name ) );
if ( is_object( $search_term ) && $search_term->term_id != $existing_usergroup->term_id )
$_REQUEST['form-errors']['name'] = __( 'Name conflicts with slug for another term. Please choose again.', 'edit-flow' );
if ( strlen( $name ) > 40 )
$_REQUEST['form-errors']['name'] = __( 'User group name cannot exceed 40 characters. Please try a shorter name.', 'edit-flow' );
// Kick out if there are any errors
if ( count( $_REQUEST['form-errors'] ) ) {
$_REQUEST['error'] = 'form-error';
return;
}
// Try to edit the Usergroup
$args = array(
'name' => $name,
'description' => $description,
);
// Gracefully handle the case where all users have been unsubscribed from the user group
$users = isset( $_POST['usergroup_users'] ) ? (array)$_POST['usergroup_users'] : array();
$users = array_map( 'intval', $users );
$usergroup = $this->update_usergroup( $existing_usergroup->term_id, $args, $users );
if ( is_wp_error( $usergroup ) )
wp_die( __( 'Error updating user group.', 'edit-flow' ) );
$args = array(
'message' => 'usergroup-updated',
);
$redirect_url = $this->get_link( $args );
wp_redirect( $redirect_url );
exit;
}
/**
* Handles a request to delete a Usergroup.
* Hooked into 'admin_init' and kicks out right away if no action
*
* @since 0.7
*/
function handle_delete_usergroup() {
if ( !isset( $_GET['page'], $_GET['action'], $_GET['usergroup-id'] )
|| $_GET['page'] != $this->module->settings_slug || $_GET['action'] != 'delete-usergroup' )
return;
if ( !wp_verify_nonce( $_GET['nonce'], 'delete-usergroup' ) )
wp_die( $this->module->messages['nonce-failed'] );
if ( !current_user_can( $this->manage_usergroups_cap ) )
wp_die( $this->module->messages['invalid-permissions'] );
$result = $this->delete_usergroup( (int)$_GET['usergroup-id'] );
if ( !$result || is_wp_error( $result ) )
wp_die( __( 'Error deleting user group.', 'edit-flow' ) );
$redirect_url = $this->get_link( array( 'message' => 'usergroup-deleted' ) );
wp_redirect( $redirect_url );
exit;
}
/**
* Handle the request to update a given Usergroup via inline edit
*
* @since 0.7
*/
function handle_ajax_inline_save_usergroup() {
if ( !wp_verify_nonce( $_POST['inline_edit'], 'usergroups-inline-edit-nonce' ) )
die( $this->module->messages['nonce-failed'] );
if ( !current_user_can( $this->manage_usergroups_cap ) )
die( $this->module->messages['invalid-permissions'] );
$usergroup_id = (int) $_POST['usergroup_id'];
if ( !$existing_term = $this->get_usergroup_by( 'id', $usergroup_id ) )
die( $this->module->messages['usergroup-missing'] );
$name = strip_tags( trim( $_POST['name'] ) );
$description = stripslashes( strip_tags( trim( $_POST['description'] ) ) );
/**
* Form validation for editing Usergroup
*/
// Check if name field was filled in
if ( empty( $name ) ) {
$change_error = new WP_Error( 'invalid', __( 'Please enter a name for the user group.', 'edit-flow' ) );
die( $change_error->get_error_message() );
}
// Check that the name doesn't exceed 40 chars
if ( strlen( $name ) > 40 ) {
$change_error = new WP_Error( 'invalid', __( 'User group name cannot exceed 40 characters. Please try a shorter name.' ) );
die( $change_error->get_error_message() );
}
// Check to ensure a term with the same name doesn't exist
$search_term = $this->get_usergroup_by( 'name', $name );
if ( is_object( $search_term ) && $search_term->term_id != $existing_term->term_id ) {
$change_error = new WP_Error( 'invalid', __( 'Name already in use. Please choose another.', 'edit-flow' ) );
die( $change_error->get_error_message() );
}
// Check to ensure a term with the same slug doesn't exist
$search_term = $this->get_usergroup_by( 'slug', sanitize_title( $name ) );
if ( is_object( $search_term ) && $search_term->term_id != $existing_term->term_id ) {
$change_error = new WP_Error( 'invalid', __( 'Name conflicts with slug for another term. Please choose again.', 'edit-flow' ) );
die( $change_error->get_error_message() );
}
// Prepare the term name and description for saving
$args = array(
'name' => $name,
'description' => $description,
);
$return = $this->update_usergroup( $existing_term->term_id, $args );
if( !is_wp_error( $return ) ) {
set_current_screen( 'edit-usergroup' );
$wp_list_table = new EF_Usergroups_List_Table();
$wp_list_table->prepare_items();
echo $wp_list_table->single_row( $return );
die();
} else {
$change_error = new WP_Error( 'invalid', sprintf( __( 'Could not update the user group: <strong>%s</strong>', 'edit-flow' ), $usergroup_name ) );
die( $change_error->get_error_message() );
}
}
/**
* Register settings for notifications so we can partially use the Settings API
* (We use the Settings API for form generation, but not saving)
*
* @since 0.7
* @uses add_settings_section(), add_settings_field()
*/
function register_settings() {
add_settings_section( $this->module->options_group_name . '_general', false, '__return_false', $this->module->options_group_name );
add_settings_field( 'post_types', __( 'Add to these post types:', 'edit-flow' ), array( $this, 'settings_post_types_option' ), $this->module->options_group_name, $this->module->options_group_name . '_general' );
}
/**
* Choose the post types for Usergroups
*
* @since 0.7
*/
function settings_post_types_option() {
global $edit_flow;
$edit_flow->settings->helper_option_custom_post_type( $this->module );
}
/**
* Validate data entered by the user
*
* @since 0.7
*
* @param array $new_options New values that have been entered by the user
* @return array $new_options Form values after they've been sanitized
*/
function settings_validate( $new_options ) {
// Whitelist validation for the post type options
if ( !isset( $new_options['post_types'] ) )
$new_options['post_types'] = array();
$new_options['post_types'] = $this->clean_post_type_options( $new_options['post_types'], $this->module->post_type_support );
return $new_options;
}
/**
* Build a configuration view so we can manage our usergroups
*
* @since 0.7
*/
function print_configure_view() {
global $edit_flow;
if ( isset( $_GET['action'], $_GET['usergroup-id'] ) && $_GET['action'] == 'edit-usergroup' ) :
/** Full page width view for editing a given usergroup **/
// Check whether the usergroup exists
$usergroup_id = (int)$_GET['usergroup-id'];
$usergroup = $this->get_usergroup_by( 'id', $usergroup_id );
if ( !$usergroup ) {
echo '<div class="error"><p>' . $this->module->messages['usergroup-missing'] . '</p></div>';
return;
}
$name = ( isset( $_POST['name'] ) ) ? stripslashes( $_POST['name'] ) : $usergroup->name;
$description = ( isset( $_POST['description'] ) ) ? stripslashes( $_POST['description'] ) : $usergroup->description;
?>
<form method="post" action="<?php echo esc_url( $this->get_link( array( 'action' => 'edit-usergroup', 'usergroup-id' => $usergroup_id ) ) ); ?>">
<div id="col-right"><div class="col-wrap"><div id="ef-usergroup-users" class="form-wrap">
<h4><?php _e( 'Users', 'edit-flow' ); ?></h4>
<?php
$select_form_args = array(
'list_class' => 'ef-post_following_list',
'input_id' => 'usergroup_users'
);
?>
<?php $this->users_select_form( $usergroup->user_ids , $select_form_args ); ?>
</div></div></div>
<div id="col-left"><div class="col-wrap"><div class="form-wrap">
<input type="hidden" name="form-action" value="edit-usergroup" />
<input type="hidden" name="usergroup_id" value="<?php echo esc_attr( $usergroup_id ); ?>" />
<?php
wp_original_referer_field();
wp_nonce_field( 'edit-usergroup' );
?>
<div class="form-field form-required">
<label for="name"><?php _e( 'Name', 'edit-flow' ); ?></label>
<input name="name" id="name" type="text" value="<?php echo esc_attr( $name ); ?>" size="40" maxlength="40" aria-required="true" />
<?php $edit_flow->settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the user group.', 'edit-flow' ) ); ?>
</div>
<div class="form-field">
<label for="description"><?php _e( 'Description', 'edit-flow' ); ?></label>
<textarea name="description" id="description" rows="5" cols="40"><?php echo esc_html( $description ); ?></textarea>
<?php $edit_flow->settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the user group is to be used for.', 'edit-flow' ) ); ?>
</div>
<p class="submit">
<?php submit_button( __( 'Update User Group', 'edit-flow' ), 'primary', 'submit', false ); ?>
<a class="cancel-settings-link" href="<?php echo esc_url( $this->get_link() ); ?>"><?php _e( 'Cancel', 'edit-flow' ); ?></a>
</p>
</div></div></div>
</form>
<?php else :
/** Full page width view to allow adding a usergroup and edit the existing ones **/
$wp_list_table = new EF_Usergroups_List_Table();
$wp_list_table->prepare_items();
?>
<script type="text/javascript">
var ef_confirm_delete_usergroup_string = "<?php _e( 'Are you sure you want to delete the user group?', 'edit-flow' ); ?>";
</script>
<div id="col-right"><div class="col-wrap">
<?php $wp_list_table->display(); ?>
</div></div>
<div id="col-left"><div class="col-wrap"><div class="form-wrap">
<h3 class="nav-tab-wrapper">
<a href="<?php echo esc_url( $this->get_link() ); ?>" class="nav-tab<?php if ( !isset( $_GET['action'] ) || $_GET['action'] != 'change-options' ) echo ' nav-tab-active'; ?>"><?php _e( 'Add New', 'edit-flow' ); ?></a>
<a href="<?php echo esc_url( $this->get_link( array( 'action' => 'change-options' ) ) ); ?>" class="nav-tab<?php if ( isset( $_GET['action'] ) && $_GET['action'] == 'change-options' ) echo ' nav-tab-active'; ?>"><?php _e( 'Options', 'edit-flow' ); ?></a>
</h3>
<?php if ( isset( $_GET['action'] ) && $_GET['action'] == 'change-options' ): ?>
<form class="basic-settings" action="<?php echo esc_url( $this->get_link( array( 'action' => 'change-options' ) ) ); ?>" method="post">
<?php settings_fields( $this->module->options_group_name ); ?>
<?php do_settings_sections( $this->module->options_group_name ); ?>
<?php echo '<input id="edit_flow_module_name" name="edit_flow_module_name" type="hidden" value="' . esc_attr( $this->module->name ) . '" />'; ?>
<?php submit_button(); ?>
</form>
<?php else: ?>
<?php /** Custom form for adding a new Usergroup **/ ?>
<form class="add:the-list:" action="<?php echo esc_url( $this->get_link() ); ?>" method="post" id="addusergroup" name="addusergroup">
<div class="form-field form-required">
<label for="name"><?php _e( 'Name', 'edit-flow' ); ?></label>
<input type="text" aria-required="true" id="name" name="name" maxlength="40" value="<?php if ( !empty( $_POST['name'] ) ) echo esc_attr( $_POST['name'] ); ?>" />
<?php $edit_flow->settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the user group.', 'edit-flow' ) ); ?>
</div>
<div class="form-field">
<label for="description"><?php _e( 'Description', 'edit-flow' ); ?></label>
<textarea cols="40" rows="5" id="description" name="description"><?php if ( !empty( $_POST['description'] ) ) echo esc_html( $_POST['description'] ) ?></textarea>
<?php $edit_flow->settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the user group is to be used for.', 'edit-flow' ) ); ?>
</div>
<?php wp_nonce_field( 'add-usergroup' ); ?>
<?php echo '<input id="form-action" name="form-action" type="hidden" value="add-usergroup" />'; ?>
<p class="submit"><?php submit_button( __( 'Add New User Group', 'edit-flow' ), 'primary', 'submit', false ); ?><a class="cancel-settings-link" href="<?php echo EDIT_FLOW_SETTINGS_PAGE; ?>"><?php _e( 'Back to Edit Flow', 'edit-flow' ); ?></a></p>
</form>
<?php endif; ?>
</div></div></div>
<?php $wp_list_table->inline_edit(); ?>
<?php endif;
}
/**
* Adds a form to the user profile page to allow adding usergroup selecting options
*/
function user_profile_page() {
global $user_id, $profileuser;
if ( !$user_id || !current_user_can( $this->manage_usergroups_cap ) )
return;
//Don't allow display of user groups from network
if ( ( !is_null( get_current_screen() ) ) && ( get_current_screen()->is_network ) )
return;
// Assemble all necessary data
$usergroups = $this->get_usergroups();
$selected_usergroups = $this->get_usergroups_for_user( $user_id );
$usergroups_form_args = array( 'input_id' => 'ef_usergroups' );
?>
<table id="ef-user-usergroups" class="form-table"><tbody><tr>
<th>
<h3><?php _e( 'Usergroups', 'edit-flow' ) ?></h3>
<?php if ( $user_id === wp_get_current_user()->ID ) : ?>
<p><?php _e( 'Select the user groups that you would like to be a part of:', 'edit-flow' ) ?></p>
<?php else : ?>
<p><?php _e( 'Select the user groups that this user should be a part of:', 'edit-flow' ) ?></p>
<?php endif; ?>
</th>
<td>
<?php $this->usergroups_select_form( $selected_usergroups, $usergroups_form_args ); ?>
<script type="text/javascript">
jQuery(document).ready(function(){
jQuery('#ef-user-usergroups ul').listFilterizer();
});
</script>
</td>
</tr></tbody></table>
<?php wp_nonce_field( 'ef_edit_profile_usergroups_nonce', 'ef_edit_profile_usergroups_nonce' ); ?>
<?php
}
/**
* Function called when a user's profile is updated
* Adds user to specified usergroups
*
* @since 0.7
*
* @param ???
* @param ???
* @param ???
* @return ???
*/
function user_profile_update( $errors, $update, $user ) {
if ( !$update )
return array( &$errors, $update, &$user );
// `get_current_screen()` is defined on most admin pages, but not all.
if( function_exists( 'get_current_screen' ) ){
//Don't allow update of user groups from network
$screen = get_current_screen();
if ( ! is_null( $screen ) && $screen->is_network ) {
return;
}
}
if ( current_user_can( $this->manage_usergroups_cap ) && wp_verify_nonce( $_POST['ef_edit_profile_usergroups_nonce'], 'ef_edit_profile_usergroups_nonce' ) ) {
// Sanitize the data and save
// Gracefully handle the case where the user was unsubscribed from all usergroups
$usergroups = isset( $_POST['ef_usergroups'] ) ? array_map( 'intval', (array)$_POST['ef_usergroups'] ) : array();
$all_usergroups = $this->get_usergroups();
foreach( $all_usergroups as $usergroup ) {
if ( in_array( $usergroup->term_id, $usergroups ) )
$this->add_user_to_usergroup( $user->ID, $usergroup->term_id );
else
$this->remove_user_from_usergroup( $user->ID, $usergroup->term_id );
}
}
return array( &$errors, $update, &$user );
}
/**
* Generate a link to one of the usergroups actions
*
* @since 0.7
*
* @param string $action Action we want the user to take
* @param array $args Any query args to add to the URL
* @return string $link Direct link to delete a usergroup
*/
function get_link( $args = array() ) {
if ( !isset( $args['action'] ) )
$args['action'] = '';
if ( !isset( $args['page'] ) )
$args['page'] = $this->module->settings_slug;
// Add other things we may need depending on the action
switch( $args['action'] ) {
case 'delete-usergroup':
$args['nonce'] = wp_create_nonce( $args['action'] );
break;
default:
break;
}
return add_query_arg( $args, get_admin_url( null, 'admin.php' ) );
}
/**
* Displays a list of usergroups with checkboxes
*
* @since 0.7
*
* @param array $selected List of usergroup keys that should be checked
* @param array $args ???
*/
function usergroups_select_form( $selected = array(), $args = null ) {
// TODO add $args for additional options
// e.g. showing members assigned to group (John Smith, Jane Doe, and 9 others)
// before <tag>, after <tag>, class, id names?
$defaults = array(
'list_class' => 'ef-post_following_list',
'list_id' => 'ef-following_usergroups',
'input_id' => 'following_usergroups'
);
$parsed_args = wp_parse_args( $args, $defaults );
extract( $parsed_args, EXTR_SKIP );
$usergroups = $this->get_usergroups();
if ( empty($usergroups) ) {
?>
<p><?php _e('No user groups were found.', 'edit-flow') ?> <a href="<?php echo esc_url( $this->get_link() ); ?>" title="<?php _e('Add a new user group. Opens new window.', 'edit-flow' ) ?>" target="_blank"><?php _e( 'Add a User Group', 'edit-flow' ); ?></a></p>
<?php
} else {
?>
<ul id="<?php echo esc_attr( $list_id ) ?>" class="<?php echo esc_attr( $list_class ) ?>">
<?php
foreach( $usergroups as $usergroup ) {
$checked = ( in_array( $usergroup->term_id, $selected ) ) ? ' checked="checked"' : '';
?>
<li>
<label for="<?php echo $input_id . esc_attr( $usergroup->term_id ); ?>" title="<?php echo esc_attr($usergroup->description) ?>">
<div class="ef-user-subscribe-actions">
<input type="checkbox" id="<?php echo esc_attr( $input_id . $usergroup->term_id ) ?>" name="<?php echo esc_attr( $input_id )?>[]" value="<?php echo esc_attr( $usergroup->term_id ) ?>"<?php echo $checked ?> />
</div>
<span class="ef-usergroup_name"><?php echo esc_html( $usergroup->name ); ?></span>
<span class="ef-usergroup_description" title="<?php echo esc_attr($usergroup->description) ?>">
<?php echo (strlen($usergroup->description) >= 50) ? substr_replace(esc_html($usergroup->description), '...', 50) : esc_html($usergroup->description); ?>
</span>
</label>
</li>
<?php
}
?>
</ul>
<?php
}
}
/**
* Core Usergroups Module Functionality
*/
/**
* Get all of the registered usergroups. Returns an array of objects
*
* @since 0.7
*
* @param array $args Arguments to filter/sort by
* @return array|bool $usergroups Array of Usergroups with relevant data, false if none
*/
function get_usergroups( $args = array() ) {
// We want empty terms by default
if ( !isset( $args['hide_empty'] ) )
$args['hide_empty'] = 0;
$usergroup_terms = get_terms( self::taxonomy_key, $args );
if ( !$usergroup_terms )
return false;
// Run the usergroups through get_usergroup_by() so we load users too
$usergroups = array();
foreach( $usergroup_terms as $usergroup_term ) {
$usergroups[] = $this->get_usergroup_by( 'id', $usergroup_term->term_id );
}
return $usergroups;
}
/**
* Get all of the data associated with a single usergroup
* Usergroup contains:
* - ID (key = term_id)
* - Slug (prefixed with our special key to avoid conflicts)
* - Name
* - Description
* - User IDs (array of IDs)
*
* @since 0.7
*
* @param string $field 'id', 'name', or 'slug'
* @param int|string $value Value for the search field
* @return object|array|WP_Error $usergroup Usergroup information as specified by $output
*/
function get_usergroup_by( $field, $value ) {
$usergroup = get_term_by( $field, $value, self::taxonomy_key );
if ( !$usergroup || is_wp_error( $usergroup ) )
return $usergroup;
// We're using an encoded description field to store extra values
// Declare $user_ids ahead of time just in case it's empty
$usergroup->user_ids = array();
$unencoded_description = $this->get_unencoded_description( $usergroup->description );
if ( is_array( $unencoded_description ) ) {
foreach( $unencoded_description as $key => $value ) {
$usergroup->$key = $value;
}
}
$usergroup = apply_filters( 'ef_usergroup_object', $usergroup );
return $usergroup;
}
/**
* Create a new usergroup containing:
* - Name
* - Slug (prefixed with our special key to avoid conflicts)
* - Description
* - Users
*
* @since 0.7
*
* @param array $args Name (optional), slug and description for the usergroup
* @param array $user_ids IDs for the users to be added to the Usergroup
* @return object|WP_Error $usergroup Object for the new Usergroup on success, WP_Error otherwise
*/
function add_usergroup( $args = array(), $user_ids = array() ) {
if ( !isset( $args['name'] ) )
return new WP_Error( 'invalid', __( 'New user groups must have a name', 'edit-flow' ) );
$name = $args['name'];
$default = array(
'name' => '',
'slug' => self::term_prefix . sanitize_title( $name ),
'description' => '',
);
$args = array_merge( $default, $args );
// Encode our extra fields and then store them in the description field
$args_to_encode = array(
'description' => $args['description'],
'user_ids' => array_unique( $user_ids ),
);
$encoded_description = $this->get_encoded_description( $args_to_encode );
$args['description'] = $encoded_description;
$usergroup = wp_insert_term( $name, self::taxonomy_key, $args );
if ( is_wp_error( $usergroup ) )
return $usergroup;
return $this->get_usergroup_by( 'id', $usergroup['term_id'] );
}
/**
* Update a usergroup with new data.
* Fields can include:
* - Name
* - Slug (prefixed with our special key, of course)
* - Description
* - Users
*
* @since 0.7
*
* @param int $id Unique ID for the usergroup
* @param array $args Usergroup meta to update (name, slug, description)
* @param array $users Users to be added to the Usergroup. If set, removes existing users first.
* @return object|WP_Error $usergroup Object for the updated Usergroup on success, WP_Error otherwise
*/
function update_usergroup( $id, $args = array(), $users = null ) {
$existing_usergroup = $this->get_usergroup_by( 'id', $id );
if ( is_wp_error( $existing_usergroup ) )
return new WP_Error( 'invalid', __( "User group doesn't exist.", 'edit-flow' ) );
// Encode our extra fields and then store them in the description field
$args_to_encode = array();
$args_to_encode['description'] = ( isset( $args['description'] ) ) ? $args['description'] : $existing_usergroup->description;
$args_to_encode['user_ids'] = ( is_array( $users ) ) ? $users : $existing_usergroup->user_ids;
$args_to_encode['user_ids'] = array_unique( $args_to_encode['user_ids'] );
$encoded_description = $this->get_encoded_description( $args_to_encode );
$args['description'] = $encoded_description;
$usergroup = wp_update_term( $id, self::taxonomy_key, $args );
if ( is_wp_error( $usergroup ) )
return $usergroup;
return $this->get_usergroup_by( 'id', $usergroup['term_id'] );
}
/**
* Delete a usergroup based on its term ID
*
* @since 0.7
*
* @param int $id Unique ID for the Usergroup
* @param bool|WP_Error Returns true on success, WP_Error on failure
*/
function delete_usergroup( $id ) {
$retval = wp_delete_term( $id, self::taxonomy_key );
return $retval;
}
/**
* Add an array of user logins or IDs to a given usergroup
*
* @since 0.7
*
* @param array $user_ids_or_logins User IDs or logins to be added to the usergroup
* @param int $id Usergroup to perform the action on
* @param bool $reset Delete all of the relationships before adding
* @return bool $success Whether or not we were successful
*/
function add_users_to_usergroup( $user_ids_or_logins, $id, $reset = true ) {
if ( !is_array( $user_ids_or_logins ) )
return new WP_Error( 'invalid', __( "Invalid users variable. Should be array.", 'edit-flow' ) );
// To dump the existing users from a usergroup, we need to pass an empty array
$usergroup = $this->get_usergroup_by( 'id', $id );
if ( $reset ) {
$retval = $this->update_usergroup( $id, null, array() );
if ( is_wp_error( $retval ) )
return $retval;
}
// Add the new users one by one to an array we'll pass back to the usergroup
$new_users = array();
foreach ( (array)$user_ids_or_logins as $user_id_or_login ) {
if ( !is_numeric( $user_id_or_login ) )
$new_users[] = get_user_by( 'login', $user_id_or_login )->ID;
else
$new_users[] = (int)$user_id_or_login;
}
$retval = $this->update_usergroup( $id, null, $new_users );
if ( is_wp_error( $retval ) )
return $retval;
return true;
}
/**
* Add a given user to a Usergroup. Can use User ID or user login
*
* @since 0.7
*
* @param int|string $user_id_or_login User ID or login to be added to the Usergroups
* @param int|array $ids ID for the Usergroup(s)
* @return bool|WP_Error $retval Return true on success, WP_Error on error
*/
function add_user_to_usergroup( $user_id_or_login, $ids ) {
if ( !is_numeric( $user_id_or_login ) )
$user_id = get_user_by( 'login', $user_id_or_login )->ID;
else