File: buttons.php

package info (click to toggle)
squirrelmail-spam-buttons 2.2-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 544 kB
  • ctags: 1,280
  • sloc: php: 4,819; sh: 143; makefile: 44
file content (821 lines) | stat: -rw-r--r-- 31,037 bytes parent folder | download
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
<?php

/**
  * SquirrelMail Spam Buttons Plugin
  * Copyright (c) 2005-2008 Paul Lesniewski <paul@squirrelmail.org>,
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * @package plugins
  * @subpackage spam_buttons
  *
  */



/**
  * Constructs spam button text
  *
  * @param array $buttons The list of buttons being added to under 1.5.2+
  *                       NOTE that this parameter is passed by reference
  *                       and is potentially modified herein.  Because it
  *                       is passed by reference, PHP 4 doesn't like a default
  *                       value being specified, so callers should pass an
  *                       empty string when it is not needed (usually only
  *                       needed under 1.5.2 during the relevant hooks, such 
  *                       as "message_list_controls").
  * @param boolean $dont_show_if_report_by_move_to_folder When true, and the
  *                                                       report-by-move-to-
  *                                                       folder method is
  *                                                       configured, don't
  *                                                       show the corresponding
  *                                                       button if the message
  *                                                       in question is an
  *                                                       attachment to another
  *                                                       message, otherwise all
  *                                                       buttons are shown no
  *                                                       matter what (OPTIONAL;
  *                                                       default = FALSE).
  *
  * @return string HTML for the buttons to be displayed (for use in 1.4.x)
  *
  */
function get_spam_buttons(&$buttons, 
                          $dont_show_if_report_by_move_to_folder=FALSE)
{

   global $show_not_spam_button, $spam_button_text, $not_spam_button_text,
          $show_is_spam_button, $username, $data_dir,
          $sb_report_spam_by_move_to_folder, 
          $sb_report_not_spam_by_move_to_folder,
          $sb_suppress_spam_button_folder,
          $sb_suppress_spam_button_folder_allow_override,
          $sb_suppress_not_spam_button_folder,
          $sb_suppress_not_spam_button_folder_allow_override,
          $sb_show_spam_button_folder,
          $sb_show_spam_button_folder_allow_override,
          $sb_show_not_spam_button_folder,
          $sb_show_not_spam_button_folder_allow_override,
          $extra_buttons;
 
   $passed_ent_id = 0;
   sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM);
   sqgetGlobalVar('mailbox',       $mailbox,       SQ_FORM);
   if (empty($mailbox)) $mailbox = 'INBOX';

   spam_buttons_init();

   if ($sb_suppress_spam_button_folder_allow_override)
   {
      $sb_suppress_spam_button_folder = getPref($data_dir, $username, 
                                                'sb_suppress_spam_button_folder', 
                                                $sb_suppress_spam_button_folder);
   }
   if ($sb_suppress_not_spam_button_folder_allow_override)
   {
      $sb_suppress_not_spam_button_folder = getPref($data_dir, $username, 
                                                    'sb_suppress_not_spam_button_folder', 
                                                    $sb_suppress_not_spam_button_folder);
   }
   if ($sb_show_spam_button_folder_allow_override)
   {
      $sb_show_spam_button_folder = getPref($data_dir, $username, 
                                            'sb_show_spam_button_folder', 
                                            $sb_show_spam_button_folder);
   }
   if ($sb_show_not_spam_button_folder_allow_override)
   {
      $sb_show_not_spam_button_folder = getPref($data_dir, $username, 
                                                'sb_show_not_spam_button_folder', 
                                                $sb_show_not_spam_button_folder);
   }


   // these options used to be a strings; these lines convert
   // values that may have already been stored in user prefs
   // as strings into proper array format (also unpacks
   // serialized arrays for SM v1.4.14+)...  perhaps this
   // code should be removed a year (or more?) after 1.4.x
   // supports multiple select folder lists on the options page
   // (but not the unserialize() calls)
   //
   if (empty($sb_suppress_spam_button_folder))
      $sb_suppress_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_suppress_spam_button_folder))
      $sb_suppress_spam_button_folder = @unserialize($sb_suppress_spam_button_folder);
   if (!is_array($sb_suppress_spam_button_folder))
      $sb_suppress_spam_button_folder = array($sb_suppress_spam_button_folder);

   if (empty($sb_suppress_not_spam_button_folder))
      $sb_suppress_not_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_suppress_not_spam_button_folder))
      $sb_suppress_not_spam_button_folder = @unserialize($sb_suppress_not_spam_button_folder);
   if (!is_array($sb_suppress_not_spam_button_folder))
      $sb_suppress_not_spam_button_folder = array($sb_suppress_not_spam_button_folder);

   if (empty($sb_show_spam_button_folder))
      $sb_show_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_show_spam_button_folder))
      $sb_show_spam_button_folder = @unserialize($sb_show_spam_button_folder);
   if (!is_array($sb_show_spam_button_folder))
      $sb_show_spam_button_folder = array($sb_show_spam_button_folder);

   if (empty($sb_show_not_spam_button_folder))
      $sb_show_not_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_show_not_spam_button_folder))
      $sb_show_not_spam_button_folder = @unserialize($sb_show_not_spam_button_folder);
   if (!is_array($sb_show_not_spam_button_folder))
      $sb_show_not_spam_button_folder = array($sb_show_not_spam_button_folder);


//TODO: create tooltip with more verbose explanation 
   $ret = '';

   if ($show_is_spam_button || $show_not_spam_button)
      $ret .= ' ';
   
   sq_change_text_domain('spam_buttons');


   // 1) is button turned on in the first place?
   // 2) either A or B below:
   //     A) if current message is tagged as spam, don't show spam button
   //     B) if not using message tag settings or not in message view, then:
   //        a) if in (one of) the ham folder(s) ($sb_show_spam_button_folder
   //           defines a list of ham folders to show the spam button in),
   //           show spam button
   //        b) otherwise, if not using the ham folder (list), then
   //           if in (one of) the spam folder(s), don't show spam button
   // 3) can't show button if caller doesn't want it shown
   //    when report method is move-to-folder and we're 
   //    looking at a message that is an attachment to another
   // 
   if ($show_is_spam_button                                              // 1
    && (current_message_is_tagged(TRUE) === FALSE                        // 2A
     || (current_message_is_tagged(TRUE) === 0                           // 2B
      && (in_array($mailbox, $sb_show_spam_button_folder)                // 2Ba
       || (empty($sb_show_spam_button_folder)                            // 2Bb
        && !in_array($mailbox, $sb_suppress_spam_button_folder)))))
    && (!$dont_show_if_report_by_move_to_folder                          // 3
     || !($sb_report_spam_by_move_to_folder && !empty($passed_ent_id))))
   {
      if (check_sm_version(1, 5, 2))
         $buttons['isSpam'] = array('value' => _($spam_button_text), 'type' => 'submit');
      else if (check_sm_version(1, 5, 1))
         $buttons[1]['isSpam'] = array(0 => _($spam_button_text), 1 => 'submit');
      else
         $ret .= '<input type="submit" name="isSpam" value="' . _($spam_button_text) . "\" />\n";
   }


   // 1) is button turned on in the first place?
   // 2) either A or B below:
   //     A) if current message is tagged as ham, don't show ham button
   //     B) if not using message tag settings or not in message view, then:
   //        a) if in (one of) the spam folder(s) ($sb_show_not_spam_button_folder
   //           defines a list of spam folders to show the ham button in),
   //           show ham button
   //        b) otherwise, if not using the spam folder (list), then
   //           if in (one of) the ham folder(s), don't show ham button
   // 3) can't show button if caller doesn't want it shown
   //    when report method is move-to-folder and we're 
   //    looking at a message that is an attachment to another
   // 
   if ($show_not_spam_button                                                 // 1
    && (current_message_is_tagged(FALSE) === FALSE                           // 2A
     || (current_message_is_tagged(FALSE) === 0                              // 2B
      && (in_array($mailbox, $sb_show_not_spam_button_folder)                // 2Ba
       || (empty($sb_show_not_spam_button_folder)                            // 2Bb
        && !in_array($mailbox, $sb_suppress_not_spam_button_folder)))))
    && (!$dont_show_if_report_by_move_to_folder                              // 3
     || !($sb_report_not_spam_by_move_to_folder && !empty($passed_ent_id))))
   {
      if (check_sm_version(1, 5, 2))
         $buttons['notSpam'] = array('value' => _($not_spam_button_text), 'type' => 'submit');
      else if (check_sm_version(1, 5, 1))
         $buttons[1]['notSpam'] = array(0 => _($not_spam_button_text), 1 => 'submit');
      else
         $ret .= '<input type="submit" name="notSpam" value="' . _($not_spam_button_text) . "\" />\n";
   }


   // add any extra buttons
   //
   foreach ($extra_buttons as $button => $button_info)
   {

      // build button
      //
      if (sb_show_custom_button_or_link($button, $button_info))
      {
         $button_name = preg_replace('/[^a-zA-Z0-9]/', '_', $button);
         if (check_sm_version(1, 5, 2))
            $buttons[$button_name] = array('value' => _($button), 'type' => 'submit');
         else if (check_sm_version(1, 5, 1))
            $buttons[1][$button_name] = array(0 => _($button), 1 => 'submit');
         else
            $ret .= '<input type="submit" name="' . $button_name . '" value="' . _($button) . "\" />\n";
      }

   }


   sq_change_text_domain('squirrelmail');

   return $ret;

}



/**
  * Adds spam/ham links to message options list on read body page
  *
  */
function sb_read_message_links_do(&$links)
{

   include_once(SM_PATH . 'plugins/spam_buttons/functions.php');

   global $show_spam_link_on_read_body, $show_not_spam_button, 
          $spam_button_text, $not_spam_button_text, $show_is_spam_button,
          $sb_report_spam_by_move_to_folder, $username,
          $sb_report_not_spam_by_move_to_folder,
          $sb_suppress_spam_button_folder, $data_dir,
          $sb_suppress_spam_button_folder_allow_override,
          $sb_suppress_not_spam_button_folder,
          $sb_suppress_not_spam_button_folder_allow_override,
          $sb_show_spam_button_folder,
          $sb_show_spam_button_folder_allow_override,
          $sb_show_not_spam_button_folder, $extra_buttons,
          $sb_show_not_spam_button_folder_allow_override;

   spam_buttons_init();

   if (!$show_spam_link_on_read_body)
      return;

   if ($sb_suppress_spam_button_folder_allow_override)
   {
      $sb_suppress_spam_button_folder = getPref($data_dir, $username, 
                                                'sb_suppress_spam_button_folder', 
                                                $sb_suppress_spam_button_folder);
   }
   if ($sb_suppress_not_spam_button_folder_allow_override)
   {
      $sb_suppress_not_spam_button_folder = getPref($data_dir, $username, 
                                                    'sb_suppress_not_spam_button_folder', 
                                                    $sb_suppress_not_spam_button_folder);
   }
   if ($sb_show_spam_button_folder_allow_override)
   {
      $sb_show_spam_button_folder = getPref($data_dir, $username, 
                                            'sb_show_spam_button_folder', 
                                            $sb_show_spam_button_folder);
   }
   if ($sb_show_not_spam_button_folder_allow_override)
   {
      $sb_show_not_spam_button_folder = getPref($data_dir, $username, 
                                                'sb_show_not_spam_button_folder', 
                                                $sb_show_not_spam_button_folder);
   }


   // these options used to be a strings; these lines convert
   // values that may have already been stored in user prefs
   // as strings into proper array format (also unpacks
   // serialized arrays for SM v1.4.14+)...  perhaps this
   // code should be removed a year (or more?) after 1.4.x
   // supports multiple select folder lists on the options page
   // (but not the unserialize() calls)
   //
   if (empty($sb_suppress_spam_button_folder))
      $sb_suppress_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_suppress_spam_button_folder))
      $sb_suppress_spam_button_folder = @unserialize($sb_suppress_spam_button_folder);
   if (!is_array($sb_suppress_spam_button_folder))
      $sb_suppress_spam_button_folder = array($sb_suppress_spam_button_folder);

   if (empty($sb_suppress_not_spam_button_folder))
      $sb_suppress_not_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_suppress_not_spam_button_folder))
      $sb_suppress_not_spam_button_folder = @unserialize($sb_suppress_not_spam_button_folder);
   if (!is_array($sb_suppress_not_spam_button_folder))
      $sb_suppress_not_spam_button_folder = array($sb_suppress_not_spam_button_folder);

   if (empty($sb_show_spam_button_folder))
      $sb_show_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_show_spam_button_folder))
      $sb_show_spam_button_folder = @unserialize($sb_show_spam_button_folder);
   if (!is_array($sb_show_spam_button_folder))
      $sb_show_spam_button_folder = array($sb_show_spam_button_folder);

   if (empty($sb_show_not_spam_button_folder))
      $sb_show_not_spam_button_folder = array();
   else if (check_sm_version(1, 4, 14) && !is_array($sb_show_not_spam_button_folder))
      $sb_show_not_spam_button_folder = @unserialize($sb_show_not_spam_button_folder);
   if (!is_array($sb_show_not_spam_button_folder))
      $sb_show_not_spam_button_folder = array($sb_show_not_spam_button_folder);


   $spam_links = array();
   $passed_ent_id = 0;
   sqgetGlobalVar('mailbox',       $mailbox,       SQ_FORM);
   sqgetGlobalVar('passed_id',     $passed_id,     SQ_FORM);
   sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM);
   sqgetGlobalVar('startMessage',  $startMessage,  SQ_FORM);
   sqgetGlobalVar('view_as_html',  $view_as_html,  SQ_FORM);
   sqgetGlobalVar('account',       $account,       SQ_FORM);


   sq_change_text_domain('spam_buttons');

//TODO: create tooltip with more verbose explanation 
   // 1) is button turned on in the first place?
   // 2) either A or B below: 
   //     A) if current message is tagged as spam, don't show spam button
   //     B) if not using message tag settings, then:
   //        a) if in (one of) the ham folder(s) ($sb_show_spam_button_folder
   //           defines a list of ham folders to show the spam button in),
   //           show spam button
   //        b) otherwise, if not using the ham folder (list), then
   //           if in (one of) the spam folder(s), don't show spam button
   // 3) can't show button if report method is move-to-folder and we're
   //    looking at a message that is an attachment to another
   //
   if ($show_is_spam_button                                              // 1
    && (current_message_is_tagged(TRUE) === FALSE                        // 2A
     || (current_message_is_tagged(TRUE) === 0                           // 2B
      && (in_array($mailbox, $sb_show_spam_button_folder)                // 2Ba
       || (empty($sb_show_spam_button_folder)                            // 2Bb
        && !in_array($mailbox, $sb_suppress_spam_button_folder)))))
    && !($sb_report_spam_by_move_to_folder && !empty($passed_ent_id)))   // 3
      $spam_links[] = array('URL' => sqm_baseuri() 
         . 'src/read_body.php?isSpam=yslnk&mailbox=' 
         . urlencode($mailbox) . '&passed_id=' . $passed_id . '&view_as_html='
         . $view_as_html . '&startMessage=' . $startMessage . '&passed_ent_id=' 
         . $passed_ent_id . '&account=' . $account, 
         'Text' => _($spam_button_text));

   // 1) is button turned on in the first place?
   // 2) either A or B below: 
   //     A) if current message is tagged as ham, don't show ham button
   //     B) if not using message tag settings, then:
   //        a) if in (one of) the spam folder(s) ($sb_show_not_spam_button_folder
   //           defines a list of spam folders to show the ham button in),
   //           show ham button
   //        b) otherwise, if not using the spam folder (list), then
   //           if in (one of) the ham folder(s), don't show ham button
   // 3) can't show button if report method is move-to-folder and we're
   //    looking at a message that is an attachment to another
   //
   if ($show_not_spam_button                                                 // 1
    && (current_message_is_tagged(FALSE) === FALSE                           // 2A
     || (current_message_is_tagged(FALSE) === 0                              // 2B
      && (in_array($mailbox, $sb_show_not_spam_button_folder)                // 2Ba
       || (empty($sb_show_not_spam_button_folder)                            // 2Bb
        && !in_array($mailbox, $sb_suppress_not_spam_button_folder)))))
    && !($sb_report_not_spam_by_move_to_folder && !empty($passed_ent_id)))   // 3
      $spam_links[] = array('URL' => sqm_baseuri() 
         . 'src/read_body.php?notSpam=yslnk&mailbox='
         . urlencode($mailbox) . '&passed_id=' . $passed_id . '&view_as_html='
         . $view_as_html . '&startMessage=' . $startMessage . '&passed_ent_id=' 
         . $passed_ent_id . '&account=' . $account, 
         'Text' => _($not_spam_button_text));

   if (check_sm_version(1, 5, 2))
      $links = array_merge($links, $spam_links);

   else
   {
      foreach ($spam_links as $link)
         echo ' | <a href="' . $link['URL'] . '">' . $link['Text'] . '</a>';
   }


   // add any extra links
   //
   foreach ($extra_buttons as $button => $button_info)
   {

      // build button
      //
      if (sb_show_custom_button_or_link($button, $button_info))
      {
         $button_name = preg_replace('/[^a-zA-Z0-9]/', '_', $button);
         $button_link = sqm_baseuri() . 'src/read_body.php?' . $button_name
                      . '=yslnk&mailbox=' . urlencode($mailbox) . '&passed_id='
                      . $passed_id . '&view_as_html=' . $view_as_html
                      . '&startMessage=' . $startMessage . '&passed_ent_id='
                      . $passed_ent_id . '&account=' . $account;
         if (check_sm_version(1, 5, 2))
            $links[] = array('URL'  => $button_link,
                             'Text' => $button);

         else
            echo ' | <a href="' . $button_link . '">' . $button . '</a>';
      }

   }


   sq_change_text_domain('squirrelmail');

}



/**
  * Adds spam/ham buttons to mailbox listing
  *
  */
function sb_mailbox_list_buttons_do(&$buttons)
{

   include_once(SM_PATH . 'plugins/spam_buttons/functions.php');

   global $show_spam_buttons_on_message_list;

   spam_buttons_init();

   if (!$show_spam_buttons_on_message_list)
      return;

   if (check_sm_version(1, 5, 1))
   {
      get_spam_buttons($buttons);
   }
   else
   {
      $temp = '';
      echo get_spam_buttons($temp);
   }

}



/**
  * Adds spam/ham buttons to message display 
  * (currently only useful in 1.5.x)
  *
  */
function sb_read_message_buttons_do($args)
{

   include_once(SM_PATH . 'plugins/spam_buttons/functions.php');

   global $show_spam_buttons_on_read_body;

   spam_buttons_init();

   if (!$show_spam_buttons_on_read_body)
      return;


   if (check_sm_version(1, 5, 2))
   {
//TODO: 1.5.2 should change the API for the buttons on the read message screen, then this code will have to change to suit
      global $oTemplate;

      sqgetGlobalVar('mailbox',       $mailbox,       SQ_FORM);
      sqgetGlobalVar('passed_id',     $passed_id,     SQ_FORM);
      sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM);
      sqgetGlobalVar('startMessage',  $startMessage,  SQ_FORM);
      sqgetGlobalVar('view_as_html',  $view_as_html,  SQ_FORM);
      sqgetGlobalVar('account',       $account,       SQ_FORM);

      $buttons = array();
      get_spam_buttons($buttons, TRUE); 

      $oTemplate->assign('buttons', $buttons);
      $oTemplate->assign('mailbox', $mailbox);
      $oTemplate->assign('passed_id', $passed_id);
      $oTemplate->assign('passed_ent_id', $passed_ent_id);
      $oTemplate->assign('startMessage', $startMessage);
      $oTemplate->assign('view_as_html', $view_as_html);
      $oTemplate->assign('account', $account);

      $output = $oTemplate->fetch('plugins/spam_buttons/read_menubar_buttons.tpl');

      return array('read_body_menu_buttons_bottom' => $output,
                   'read_body_menu_buttons_top' => $output);
   }


   // as of SM version 1.5.0, this works a little differently
   //
   else if (check_sm_version(1, 5, 0))
   {

      sqgetGlobalVar('mailbox',       $mailbox,       SQ_FORM);
      sqgetGlobalVar('passed_id',     $passed_id,     SQ_FORM);
      sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM);
      sqgetGlobalVar('startMessage',  $startMessage,  SQ_FORM);
      sqgetGlobalVar('view_as_html',  $view_as_html,  SQ_FORM);

      // add spam buttons after delete stuff
      //
      $temp = '';
      $args[1] = preg_replace('/<\/td>/', 
                 '<form method="post" style="display: inline">' 
               . get_spam_buttons($temp, TRUE) 
               . '<input type="hidden" name="mailbox" value="' . $mailbox . '" />'
               . '<input type="hidden" name="msg[0]" value="' . $passed_id . '" />'
               . '<input type="hidden" name="passed_ent_id" value="' . $passed_ent_id . '" />'
               . '<input type="hidden" name="view_as_html" value="' . $view_as_html . '" />'
               . '<input type="hidden" name="startMessage" value="' . $startMessage . '" />'
               . '</form></td>', $args[1], 1);
   
      return $args;

   }


   // all older versions...  way too much trouble, especially if 
   // preview pane is in use; read_body_header_right will be 
   // sufficient
   //
   else
   {

      return;

   }


}



/**
  * Determine if the current message being viewed is spam or ham
  *
  * If the configuration items related to this functionality are
  * not set, or we are not on a message view screen, this always 
  * returns 0 (see WARNING below).
  *
  * @param boolean $spam When TRUE, check if the message is spam,
  *                      when FALSE, check if the message is ham.
  *
  * @return mixed TRUE if the message has been tagged as inquired
  *               FALSE if the message has not been tagged as such
  *               0 if the needed configuration settings are not
  *               set up in the configuration file or the current
  *               page request is not the message view page.  
  *               WARNING: callers need to carefully check for 
  *               either 0 or FALSE (using === or !==).
  *
  */
function current_message_is_tagged($spam)
{

   if (defined('PAGE_NAME'))
   {
      if (PAGE_NAME != 'read_body') return 0;
   }
   else
   {
      global $PHP_SELF;
      if (strpos($PHP_SELF, '/src/read_body') === FALSE) 
         return 0;
   }

   global $sb_spam_header_name, $sb_not_spam_header_name,
          $sb_spam_header_value, $sb_not_spam_header_value;

   spam_buttons_init();

   sqgetGlobalVar('passed_id',     $passed_id,     SQ_FORM);
   sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM);

   if ($spam)
   {

      if (empty($sb_spam_header_name) || empty($sb_spam_header_value))
         return 0;

      $header = sb_get_message_header($passed_id, $passed_ent_id, $sb_spam_header_name);
      if (preg_match($sb_spam_header_value, trim($header[1])))
         return TRUE;

/* ......old code, less efficient; left for posterity............................
      $headers = sb_get_message_headers($passed_id, $passed_ent_id);
      foreach ($headers as $header)
         if (strtolower($header[0]) == strtolower($sb_spam_header_name . ':')
          && preg_match($sb_spam_header_value, trim($header[1])))
            return TRUE;
............................................................................. */

      return FALSE;

   }
   else 
   {

      if (empty($sb_not_spam_header_name) || empty($sb_not_spam_header_value))
         return 0;

      $header = sb_get_message_header($passed_id, $passed_ent_id, $sb_not_spam_header_name);
      if (preg_match($sb_not_spam_header_value, trim($header[1])))
         return TRUE;

/* ......old code, less efficient; left for posterity............................
      $headers = sb_get_message_headers($passed_id, $passed_ent_id);
      foreach ($headers as $header)
         if (strtolower($header[0]) == strtolower($sb_not_spam_header_name . ':')
          && preg_match($sb_not_spam_header_value, trim($header[1])))
            return TRUE;
............................................................................. */

      return FALSE;

   }

}



/**
  * Determines if a custom/extra button or link should be shown.
  *
  * @param string $button_name The name of the button or link
  * @param array  $button_info The array of button callbacks and
  *                            associated information from the
  *                            configuration file
  *
  * @return boolean TRUE if the button should be shown, or FALSE
  *                 if it should not.
  *
  */
function sb_show_custom_button_or_link($button_name, $button_info)
{

   global $username;
   $callback = '';
   $action = '';
   $passed_id = '';
   $passed_ent_id = '';
   $from = '';
   $error = '';
   $show_it = FALSE;


   // this function is found in the Compatibility plugin v2.0.5+
   //
   $hook_name = get_current_hook_name();


   sq_change_text_domain('spam_buttons');


   // in this case, SquirrelMail is building the buttons at the
   // top of the message list screen
   //
   if ($hook_name == 'mailbox_display_buttons'  // SM 1.4.x
    || $hook_name == 'message_list_controls')  // SM 1.5.x
   {
      $action = 'MESSAGE_LIST_BUTTON';
      if (!isset($button_info[0]))
         $error = sprintf(_("Spam Buttons plugin is not configured correctly!  Check custom button configuration array for \"%s\""), $button_name);
      else
         $callback = $button_info[0];
   }


   // in this case, SquirrelMail is building the "Options" links
   // on the message view screen
   //
   else if ($hook_name == 'read_body_header_right')
   {

      $action = 'MESSAGE_VIEW_LINK';
      if (!isset($button_info[1]))
         $error = sprintf(_("Spam Buttons plugin is not configured correctly!  Check custom button configuration array for \"%s\""), $button_name);
      else
         $callback = $button_info[1];


      // identify the message being viewed in case they are needed
      //
      sqgetGlobalVar('passed_id',     $passed_id,     SQ_FORM);
      sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM);


      // this retrieves the message's From header in the format
      // array(0 => 'From:', 1 => '"Jose" <jose@example.org>')
      //
      $from = sb_get_message_header($passed_id, $passed_ent_id, 'From');


      // this parses out just the email address portion of the From header
      //
      if (function_exists('parseRFC822Address'))
      {
         $from = parseRFC822Address($from[1], 1);
         $from = $from[0][2] . '@' . $from[0][3];
      }
      else
      {
         $from = parseAddress($from[1], 1);
         $from = $from[0][0];
      }

   }


   // in this case, SquirrelMail is building the buttons in the
   // message view screen's button row (SquirrelMail 1.5.2+ only)
   //
   else if ($hook_name == 'template_construct_read_menubar_buttons.tpl')
   {
// NOTE: at some point, 1.5.x is likely to change the API for the buttons on the read message screen, then this code will have to change to suit

      $action = 'MESSAGE_VIEW_BUTTON';
      if (!isset($button_info[2]))
         $error = sprintf(_("Spam Buttons plugin is not configured correctly!  Check custom button configuration array for \"%s\""), $button_name);
      else
         $callback = $button_info[2];


      // these values identify the message being viewed
      // in case you need them
      //
      sqgetGlobalVar('passed_id',     $passed_id,     SQ_FORM);
      sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM);


      // this retrieves the message's From header in the format
      // array(0 => 'From:', 1 => '"Jose" <jose@example.org>')
      //
      $from = sb_get_message_header($passed_id, $passed_ent_id, 'From');


      // this parses out just the email address portion of the From header
      //
      if (function_exists('parseRFC822Address'))
      {
         $from = parseRFC822Address($from[1], 1);
         $from = $from[0][2] . '@' . $from[0][3];
      }
      else
      {
         $from = parseAddress($from[1], 1);
         $from = $from[0][0];
      }

   }


   // is the button always to be shown, or never to be shown?
   //
   if (empty($error))
   {
      if ($callback === 1 || $callback === '1')
      {
         sq_change_text_domain('squirrelmail');
         return TRUE;
      }
      if ($callback === 0 || $callback === '0')
      {
         sq_change_text_domain('squirrelmail');
         return FALSE;
      }
   }


   // otherwise, execute callback to figure it out...
   //
   if (empty($callback))
      $error = sprintf(_("Spam Buttons plugin is not configured correctly!  Check custom button configuration array for \"%s\""), $button_name);
   else if (!function_exists($callback))
      $error = sprintf(_("Function \"%s\" not found in Spam Buttons plugin"), $callback);
   else
      $show_it = $callback($action, $username, $from, $passed_id, $passed_ent_id);


   // error?
   //
   if (!empty($error))
   {
      global $color;
      sq_change_text_domain('squirrelmail');
      $ret = plain_error_message($error, $color);
      if (check_sm_version (1, 5, 2))
      {
         echo $ret;
         global $oTemplate;
         $oTemplate->display('footer.tpl');
      }
      exit;
   }


   // return value from the callback
   //
   sq_change_text_domain('squirrelmail');
   return $show_it;

}