scanner.module 40.5 KB
Newer Older
1
2
3
4
5
<?php

/**
 * @file
 * Search and Replace Scanner - works on all nodes text content.
6
7
8
9
10
11
 *
 * The Search and Replace Scanner can do regular expression matches
 * against the title, body and CCK text content fields on all nodes in your system.
 * This is useful for finding html strings that Drupal's normal search will
 * ignore. And it can replace the matched text. Very handy if you are changing
 * the name of your company, or are changing the URL of a link included
Tao Starbow's avatar
Tao Starbow committed
12
 * multiple times in multiple nodes.
13
14
 *
 * The module allow you to configure which fields and tables to work with,
Tao Starbow's avatar
Tao Starbow committed
15
 * and also to add in custom tables and fields for modules that don't use CCK.
16
 *
Tao Starbow's avatar
Tao Starbow committed
17
18
 * Limitations:
 *  Only works with Mysql
19
 *
Tao Starbow's avatar
Tao Starbow committed
20
 * Warning:
21
 *  This is a very powerful tool, and as such is very dangerous.  You can
Tao Starbow's avatar
Tao Starbow committed
22
23
 *  easy distroy your entire site with it.  Be sure to backup your database
 *  before using it.  No, really.
24
 *
Tao Starbow's avatar
Tao Starbow committed
25
 * Todo:
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 *  Provide better highlighting for search results
 *   - right now there's a known bug where multiple search terms
 *     on the same line aren't all highlighted. (The hit count
 *     is correct, though, and all items are replaced correctly.)
 *
 * Credits:
 *  Version 5.x-1.0 by:
 *   - Tao Starbow http://www.starbowconsulting.com
 *     Drupal username: starbow
 *  Version 5.x-2.0 by:
 *   - Amit Asaravala http://www.returncontrol.com
 *     Drupal username: aasarava
 *   - Jason Salter jason http://www.fivepaths.com
 *     Drupal username: jpsalter
 *   - Sponsored by Five Paths Consulting http://www.fivepaths.com
41
42
 */

43
44
45
46
47
48
49
50
51
52
53
54
55

//The special characters to escape if a search string is not a regex string:
define('SCANNER_REGEX_CHARS', '.\/+*?[^]$() {}=!<>|:');

//The modes that the search-and-replace process can be in.
//We need to track the modes to prevent accidentally starting a replacement
// or a long search if a user leaves mid-way through the process
// and comes back again w/ the same session variables.
define('SCANNER_STATUS_GO_SEARCH', 1);
define('SCANNER_STATUS_GO_CONFIRM', 2);
define('SCANNER_STATUS_GO_REPLACE', 3);


56
57
58
/**
 * Implementation of hook_menu().
 */
59
function scanner_menu() {
60

61
62
    $items['admin/content/scanner'] = array(
      'title' => 'Search and Replace Scanner',
63
      'description' => 'Find (and replace) keywords in all your content.',
64
65
      'page callback' => 'scanner_view',
      'access arguments' => array('perform search and replace'),
66
    );
67
    $items['admin/content/scanner/scan'] = array(
68
      'title' => 'Search',
69
      'access arguments' => array('perform search and replace'),
Tao Starbow's avatar
Tao Starbow committed
70
      'type' => MENU_DEFAULT_LOCAL_TASK,
71
    );
72
    $items['admin/content/scanner/scan/confirm'] = array(
73
      'title' => 'Confirm Replace',
74
75
76
      'access arguments' => array('perform search and replace'),
      'page callback' => 'drupal_get_form',
      'page arguments' => array('scanner_confirm_form'),
77
78
      'type' => MENU_CALLBACK,
    );
79
    $items['admin/content/scanner/undo/confirm'] = array(
80
      'title' => 'Confirm Undo',
81
82
83
      'access arguments' => array('perform search and replace'),
      'page callback' => 'drupal_get_form',
      'page arguments' => array('scanner_undo_confirm_form'),
84
85
      'type' => MENU_CALLBACK,
    );
86
    $items['admin/content/scanner/settings'] = array( // Shows up on scanner page as tab.
87
      'title' => 'Settings',
88
89
90
91
      'page callback' => 'drupal_get_form',
      'page arguments' => array('scanner_admin_form'),
      'access arguments' => array('administer scanner settings'),
      'type' => MENU_LOCAL_TASK,
92
93
      'weight' => 1,
    );
94
    $items['admin/content/scanner/undo'] = array( // Shows up on scanner page as tab.
95
      'title' => 'Undo',
96
97
98
      'page callback' => 'scanner_undo_page',
      'access arguments' => array('perform search and replace'),
      'type' => MENU_LOCAL_TASK,
99
    );
100
    $items['admin/settings/scanner'] = array( // Shows up on admin page.
101
      'title' => t('Search and Replace Scanner'),
102
      'description' => 'Configure defaults and what fields can be searched and replaced.',
103
104
105
      'page callback' => 'drupal_get_form',
      'page arguments' => array('scanner_admin_form'),
      'access arguments' => array('administer scanner settings'),
106
    );
107
108
109
  return $items;
}

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
function scanner_theme() {
  return array(
    'scanner_results' => array(
      'file' => 'scanner.module',
      'arguments' => array(
        'results' => NULL,
      ),
    ),
    'scanner_item' => array(
      'file' => 'scanner.module',
      'arguments' => array(
        'item' => NULL,
      ),
    ),
    'scanner_replace_results' => array(
      'file' => 'scanner.module',
      'arguments' => array(
        'results' => NULL,
      ),
    ),
    'scanner_replace_item' => array(
      'file' => 'scanner.module',
      'arguments' => array(
        'item' => NULL,
      ),
    ),
  );
}


140
141
142
143
144
145
146
/**
 * Implementation of hook_perm().
 */
function scanner_perm() {
  return array('administer scanner settings', 'perform search and replace');
}

147
148
149
150
/**
 * Menu callback; presents the scan form and results.
 */
function scanner_view() {
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
  //using set_html_head because it seems unecessary to load a separate css
  // file for just two simple declarations:
  drupal_set_html_head('
    <style type="text/css">
      #scanner-form .form-submit { margin-top:0; }
      #scanner-form .form-item { margin-bottom:0; }
    </style>
  ');

  //javascript checks to make sure user has entered some search text:
  drupal_add_js("
    $(document).ready(function() {
      $('input[@type=submit][@value=Search]').click(function() {
        var searchfield = $('#edit-search');
        var chars = searchfield.val().length;
        if (chars == 0) {
          alert('Please provide some search text and try again.');
          searchfield.addClass('error');
          searchfield[0].focus();
          return FALSE;
        } else if (chars < 3) {
          return confirm('Searching for a keyword that has fewer than three characters could take a long time. Are you sure you want to continue?');
        }
        return TRUE;
      });
    });
  ", 'inline');

  $search = $_SESSION['scanner_search'];
  $status = $_SESSION['scanner_status'];
  if (!is_NULL($search) && $status >= SCANNER_STATUS_GO_SEARCH) {

    if ($status == SCANNER_STATUS_GO_CONFIRM) {
      drupal_goto('admin/content/scanner/scan/confirm');

    }
    else if ($status == SCANNER_STATUS_GO_REPLACE) {
      $resulttxt = '<a name="results"></a>'. t('Replacement Results');
      $results = scanner_execute('replace');

191
192
    }
    else {
193
194
      $resulttxt = t('Search Results');
      $results = scanner_execute('search');
195
    }
196

197
    if ($results) {
198
      $results = '<a name="results"></a>'. theme('box', $resulttxt, $results);
199
200
    }
    else {
201
      $results = theme('box', t('Your scan yielded no results'), NULL);
202
203
    }

204
    $output = drupal_get_form('scanner_form');
205
206
    $output .= $results;

207
208
209
210
211
212
213
214
215
216
217
218
219
    //clear any old search form input:
    unset($_SESSION['scanner_search']);
    unset($_SESSION['scanner_replace']);
    unset($_SESSION['scanner_preceded']);
    unset($_SESSION['scanner_followed']);
    unset($_SESSION['scanner_mode']);
    unset($_SESSION['scanner_wholeword']);
    unset($_SESSION['scanner_published']);
    unset($_SESSION['scanner_regex']);
    unset($_SESSION['scanner_terms']);
    //clear old status:
    unset($_SESSION['scanner_status']);

220
221
    return $output;
  }
222
223

  return $output . drupal_get_form('scanner_form');
224
225
226
227
228
229
230
231
232
}

/**
 * The search and replace form.
 *
 * @param str $search - regex to search for.
 * @param str $replace - string to substitute.
 * @return $form
 */
233
function scanner_form(&$form_state) {
234
  $form = array();
235
236
237
238
239
240
241
242
243
244
245
246

  $search = $_SESSION['scanner_search'];
  $replace = $_SESSION['scanner_replace'];
  $preceded = $_SESSION['scanner_preceded'];
  $followed = $_SESSION['scanner_followed'];
  $mode = isset($_SESSION['scanner_mode']) ? $_SESSION['scanner_mode'] : variable_get('scanner_mode', 0);
  $wholeword = isset($_SESSION['scanner_wholeword']) ? $_SESSION['scanner_wholeword'] : variable_get('scanner_wholeword', 0);
  $published = isset($_SESSION['scanner_published']) ? $_SESSION['scanner_published'] : variable_get('scanner_published', 1);
  $regex = isset($_SESSION['scanner_regex']) ? $_SESSION['scanner_regex'] : variable_get('scanner_regex', 0);
  $terms = $_SESSION['scanner_terms'];

  $form['search'] = array(
247
248
    '#type' => 'textfield',
    '#default_value' => $search,
249
250
    '#title' => t('Step 1: Search for'),
    '#maxlength' => 256,
251
  );
252
253
254
  $form['submit_search'] = array(
    '#type' => 'submit',
    '#value' => t('Search'),
255
256
  );

257
258
259
260
261
  $form['replace'] = array(
    '#type' => 'textfield',
    '#default_value' => $replace,
    '#title' => t('Step 2: Replace with'),
    '#maxlength' => 256,
262
263
264
265
  );
  $form['submit_replace'] = array(
    '#type' => 'submit',
    '#value' => t('Replace'),
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
  );

  $form['options'] = array(
    '#type' => 'fieldset',
    '#title' => t('Search Options'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );

  $form['options']['surrounding'] = array(
    '#type' => 'fieldset',
    '#title' => t('Surrounding Text'),
    '#collapsible' => FALSE,
    '#description' => t('You can limit matches by providing the text that should appear immediately before or after the search text. Remember to account for spaces.  Note: Case sensitivity and regular expression options will all apply here, too. Whole word is not recommended.'),
  );

  $form['options']['surrounding']['preceded'] = array(
    '#type' => 'textfield',
    '#title' => t('Preceded by'),
    '#default_value' => $preceded,
    '#maxlength' => 256,
  );

  /* TODO: for possible future implementation...
   * Depends on whether negative lookahead and negative lookbehind
   *  can accurately be approximated in MySQL...
  $form['options']['surrounding']['notpreceded'] = array(
    '#type' => 'checkbox',
    '#title' => t('NOT preceded by the text above'),
    '#default_value' => $notpreceded,
  );
  */

  $form['options']['surrounding']['followed'] = array(
    '#type' => 'textfield',
    '#title' => t('Followed by'),
    '#default_value' => $followed,
    '#maxlength' => 256,
  );

  /* TODO: for possible future implementation...
   * Depends on whether negative lookahead and negative lookbehind
   *  can accurately be approximated in MySQL...
  $form['options']['surrounding']['notfollowed'] = array(
    '#type' => 'checkbox',
    '#title' => t('NOT followed by the text above'),
    '#default_value' => $notfollowed,
  );
  */

  $form['options']['mode'] = array(
    '#type' => 'checkbox',
    '#title' => t('Case sensitive search'),
    '#default_value' => $mode,
    '#description' => t("Check this if the search should only return results that exactly match the capitalization of your search terms."),
  );

  $form['options']['wholeword'] = array(
    '#type' => 'checkbox',
    '#title' => t('Match whole word'),
    '#default_value' => $wholeword,
    '#description' => t("Check this if you don't want the search to match any partial words. For instance, if you search for 'run', a whole word search will <em>not</em> match 'running'."),
  );

  $form['options']['regex'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use regular expressions in search'),
    '#default_value' => $regex,
    '#description' => t('Check this if you want to use regular expressions in your search terms.'),
  );

  $form['options']['published'] = array(
    '#type' => 'checkbox',
    '#title' => t('Published nodes only'),
    '#default_value' => $published,
    '#description' => t('Check this if you only want your search and replace to affect fields in nodes that are published.'),
  );

  $scanner_vocabularies = array_filter(variable_get('scanner_vocabulary', array()));

  if (count($scanner_vocabularies)) {

    $vocabularies = taxonomy_get_vocabularies();
    $options = array();

    foreach ($vocabularies as $vid => $vocabulary) {
      if (in_array($vid, $scanner_vocabularies) ) {
        $tree = taxonomy_get_tree($vid);
        if ($tree && (count($tree) > 0)) {
          $options[$vocabulary->name] = array();
          foreach ($tree as $term) {
            $options[$vocabulary->name][$term->tid] = str_repeat('-', $term->depth) . $term->name;
          }
        }
      }
    }

    $form['options']['terms'] = array(
      '#type' => 'select',
      '#title' => t('Only match nodes with these terms'),
      '#options' => $options,
      '#default_value' => $terms,
      '#multiple' => TRUE,
    );
  }

372
373
374
375
  return $form;
}

/**
376
377
 * Validate form input.
 */
378
379
function scanner_form_validate($form, &$form_state) {
  $search = trim($form_state['values']['search']);
380
381
382
383
384
385
386
  if ($search == '') {
    form_set_error('search', t('Please enter some keywords.'));
  }
}

/**
 * Handles submission of the search and replace form.
387
 *
388
389
 * @param $form
 * @param $form_state
390
391
 * @return the new path that will be goto'ed.
 */
392
function scanner_form_submit($form, &$form_state) {
393
  //save form input:
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
  $_SESSION['scanner_search']    = $form_state['values']['search'];
  $_SESSION['scanner_preceded']  = $form_state['values']['preceded'];
  //$_SESSION['scanner_notpreceded'] = $form_state['values']['notpreceded'];
  $_SESSION['scanner_followed']  = $form_state['values']['followed'];
  //$_SESSION['scanner_notfollowed'] = $form_state['values']['notfollowed'];
  $_SESSION['scanner_mode']      = $form_state['values']['mode'];
  $_SESSION['scanner_wholeword'] = $form_state['values']['wholeword'];
  $_SESSION['scanner_published'] = $form_state['values']['published'];
  $_SESSION['scanner_regex']     = $form_state['values']['regex'];
  $_SESSION['scanner_terms']     = $form_state['values']['terms'];
  $_SESSION['scanner_replace']   = $form_state['values']['replace'];

/* TODO The 'op' element in the form values is deprecated.
   Each button can have #validate and #submit functions associated with it.
   Thus, there should be one button that submits the form and which invokes
   the normal form_id_validate and form_id_submit handlers. Any additional
   buttons which need to invoke different validate or submit functionality
   should have button-specific functions. */
  if ($form_state['values']['op'] == 'Replace') {
413
414
415
416
    $_SESSION['scanner_status'] = SCANNER_STATUS_GO_CONFIRM;
  }
  else {
    $_SESSION['scanner_status'] = SCANNER_STATUS_GO_SEARCH;
417
  }
418
  $form_state['redirect'] = 'admin/content/scanner';
419
420
421
422
423
424
425
426
}


/**
 * Scanner confirmation form to prevent people from accidentally
 * replacing things they don't intend to.
 */
function scanner_confirm_form() {
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
  //using set_html_head because it seems unecessary to load a separate css
  // file for just one declaration:
  //you can override the styles by declaring with something "higher up"
  // the chain, like:  #wrapper #scanner-confirm-form .scanner-buttons .scanner-button-msg {...}
  drupal_set_html_head('
    <style type="text/css">
      #scanner-confirm-form .scanner-buttons .scanner-button-msg {
        position:absolute;
        top:0; left:0; z-index:100;
        width:100%; height:100%;
        background-color:#000; opacity:0.75;
        font-size:1.2em;
      }
      #scanner-confirm-form .scanner-buttons .scanner-button-msg p {
        color:#fff;
      }
    </style>
  ');

  //javascript to prevent further clicks on confirmation button after it's clicked once.
  //unfortunately we can't just use css disable to disable the button because then
  // the op values aren't sent to drupal correctly.
  drupal_add_js("
    $(document).ready(function() {
      $('input[@type=submit][@value=Yes, Continue]').click(function() {
        $('.scanner-buttons').css('position','relative')
          .append('<div class=\"scanner-button-msg\"><p>Replacing items... please wait...</p></div>')
        $('.scanner-button-msg').click(function() { return false; });
        return true;
      });
    });
  ", 'inline');

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
  $form = array();

  $search    = $_SESSION['scanner_search'];
  $replace   = $_SESSION['scanner_replace'];
  $preceded  = $_SESSION['scanner_preceded'];
  $followed  = $_SESSION['scanner_followed'];
  $wholeword = $_SESSION['scanner_wholeword'];
  $regex     = $_SESSION['scanner_regex'];
  $mode      = $_SESSION['scanner_mode'];

  $modetxt = ($mode) ? t('Case sensitive') : t('Not case sensitive: will replace any matches regardless of capitalization.');

  $msg = (
    '<p>'. t('Are you sure you want to make the following replacement?') .'</p>'.
    '<div class="scanner-confirm">'.
    '  <label>'. t('Search for') .':</label> ['. check_plain($search) .']'.
    '</div>'
  );
  if ($preceded) {
    $msg .= (
      '<div class="scanner-confirm">'.
      '  <label>'. t('Preceded by') .':</label> ['. check_plain($preceded) .']'.
      '</div>'
    );
  }
  if ($followed) {
    $msg .= (
      '<div class="scanner-confirm">'.
      '  <label>'. t('Followed by') .':</label> ['. check_plain($followed) .']'.
      '</div>'
    );
  }
  $msg .= (
    '<div class="scanner-confirm">'.
    '  <label>'. t('Replace with') .':</label> ['. check_plain($replace) .']'
  );
  if ($replace === '') {
    $msg .= ' <span class="warning">This will delete any occurences of the search terms!</span>';
  }
  $msg .= (
    '</div>'.
    '<div class="scanner-confirm">'.
    '  <label>'. t('Mode') .':</label> '. $modetxt .
    '</div>'
  );
  if ($wholeword) {
    $msg .= (
      '<div class="scanner-confirm">'.
      '  <label>'. t('Match whole word') .':</label> '. t('Yes') .
      '</div>'
    );
  }
  if ($regex) {
    $msg .= (
      '<div class="scanner-confirm">'.
      '  <label>'. t('Use regular expressions') .':</label> '. t('Yes') .
      '</div>'
    );
  }

  $form['warning'] = array(
    '#type' => 'markup',
    '#value' => $msg,
  );

  $form['confirm'] = array(
    '#type' => 'submit',
    '#value' => t('Yes, Continue'),
528
    '#prefix' => '<div class="scanner-buttons">', //see suffix in cancel button element
529
530
531
532
  );
  $form['cancel'] = array(
    '#type' => 'submit',
    '#value' => t('No, Cancel'),
533
    '#suffix' => '</div>', //see prefix in confirm button element
534
535
536
537
538
539
540
541
542
  );

  return $form;
}


/**
 * Submission handling for scanner confirmation form.
 */
543
544
545
546
547
548
549
550
function scanner_confirm_form_submit($form, &$form_state) {
/* TODO The 'op' element in the form values is deprecated.
   Each button can have #validate and #submit functions associated with it.
   Thus, there should be one button that submits the form and which invokes
   the normal form_id_validate and form_id_submit handlers. Any additional
   buttons which need to invoke different validate or submit functionality
   should have button-specific functions. */
  if ($form_state['values']['op'] == t('Yes, Continue')) {
551
552
553
554
555
556
    $_SESSION['scanner_status'] = SCANNER_STATUS_GO_REPLACE;
  }
  else {
    unset($_SESSION['scanner_status']);
  }

557
  $form_state['redirect'] = 'admin/content/scanner';
558
559
560
561
562
563
564
565
566
567
568
}

function scanner_undo_page() {
  $header = array(t('Date'), t('Searched'), t('Replaced'), t('Count'), t('Operation'));

  $sandrs = db_query('SELECT undo_id, time, searched, replaced, count, undone FROM {scanner} ORDER BY undo_id DESC');

  while ($sandr = db_fetch_object($sandrs)) {

    $query = 'undo_id='. $sandr->undo_id;
    if ($sandr->undone) {
569
      $operation = l('Redo', 'admin/content/scanner/undo/confirm', array('query' => $query));
570
571
    }
    else {
572
      $operation = l('Undo', 'admin/content/scanner/undo/confirm', array('query' => $query));
573
    }
574
575
576
577
578
579
580
581

    $rows[] = array(
      format_date($sandr->time),
      check_plain($sandr->searched),
      check_plain($sandr->replaced),
      $sandr->count,
      $operation,
    );
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

  return theme('table', $header, $rows, NULL, 'Prior Search and Replace Events');
}

function scanner_undo_confirm_form() {

  $undo_id = $_GET['undo_id'];

  if ($undo_id > 0) {
    $undo = db_fetch_object(db_query('SELECT undo_id, searched, replaced FROM {scanner} WHERE undo_id = %d', $undo_id));
  }

  if ($undo->undo_id > 0) {
    $form['info'] = array(
      '#value' => '<h2>'. t('Do you want to undo:') .'</h2>'.
                  '<h3>'.  t('Searched for:') .'</h3>'.
                  '<p>[<em>'. check_plain($undo->searched) .'</em>]</p>'.
                  '<h3>'. t('Replaced with:') .'</h3>'.
                  '<p>[<em>'. check_plain($undo->replaced) .'</em>]</p>',
    );

    $form['undo_id'] = array(
      '#type' => 'hidden',
      '#value' => $undo->undo_id,
    );

    $form['confirm'] = array(
      '#type' => 'submit',
      '#value' => t('Yes, Continue'),
    );

    $form['cancel'] = array(
      '#type' => 'submit',
      '#value' => t('No, Cancel'),
    );

  }
  else {
    $form['info'] = array(
      '#value' => '<h2>'. t('No undo event was found') .'</h2>',
    );
  }

  return $form;
}

629
function scanner_undo_confirm_form_submit($form, &$form_state) {
630

631
632
633
634
635
636
637
638
/* TODO The 'op' element in the form values is deprecated.
   Each button can have #validate and #submit functions associated with it.
   Thus, there should be one button that submits the form and which invokes
   the normal form_id_validate and form_id_submit handlers. Any additional
   buttons which need to invoke different validate or submit functionality
   should have button-specific functions. */
  if ($form_state['values']['op'] == t('Yes, Continue')) {
    $undo = db_fetch_object(db_query('SELECT undo_data, undone FROM {scanner} WHERE undo_id = %d', $form_state['values']['undo_id']));
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

    $undos = unserialize($undo->undo_data);

    foreach ($undos as $nid => $sandr_event) {

      if ($undo->undone == 0) {
        $vid = $sandr_event['old_vid'];
        $undone = 1;
      }
      else {
        $vid = $sandr_event['new_vid'];
        $undone = 0;
      }

      $node = node_load($nid, $vid);

      $node->revision = TRUE;
      $node->log = t('Copy of the revision from %date via Search and Replace Undo', array('%date' => format_date($node->revision_timestamp)));

      node_save($node);
      ++$count;

    }

    drupal_set_message($count .' '. t('Nodes reverted'));
664
    db_query('UPDATE {scanner} SET undone = %d WHERE undo_id = %d', $undone, $form_state['values']['undo_id']);
665
666
667
668
669
670

  }
  else {
    drupal_set_message(t('Undo / Redo canceled'));
  }

671
672
  $form_state['redirect'] = 'admin/content/scanner/undo';
  $form_state['nid'] = $node->nid;
673
674
675
}

/**
676
 * Handles the actual search and replace.
677
 *
678
 * @param str $searchtype - either 'search', or 'replace'
679
680
 * @return The themed results.
 */
681
682
function scanner_execute($searchtype = 'search') {
  global $user;
683
  
684
685
686
687
688
689
  // variables to monitor possible timeout
  $max_execution_time = ini_get('max_execution_time');
  $start_time = time();
  $expanded = FALSE;

  // get process and undo data if saved from timeout
690
691
  $processed = variable_get('scanner_partially_processed_'. $user->uid, array());
  $undo_data = variable_get('scanner_partial_undo_'. $user->uid, array());
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
  unset($_SESSION['scanner_status']);

  $search      = $_SESSION['scanner_search'];
  $replace     = $_SESSION['scanner_replace'];
  $preceded    = $_SESSION['scanner_preceded'];
  //$notpreceded = $_SESSION['scanner_notpreceded'];
  $followed    = $_SESSION['scanner_followed'];
  //$notfollowed = $_SESSION['scanner_notfollowed'];
  $mode        = $_SESSION['scanner_mode'];
  $wholeword   = $_SESSION['scanner_wholeword'];
  $published   = $_SESSION['scanner_published'];
  $regex       = $_SESSION['scanner_regex'];
  $terms       = $_SESSION['scanner_terms'];

  if ($searchtype == 'search') {
    drupal_set_message(t('Scanning for: [%search] ...', array('%search' => $search)));
  }
  else { //searchtype == 'replace'
    drupal_set_message(t('Replacing [%search] with [%replace] ...', array('%search' => $search, '%replace' => $replace)));
  }

  if ($mode) { // Case Sensitive
    $where = "CAST(t.%s AS BINARY) "; // BINARY to force case sensative.
    $flag = NULL;
  }
  else { // Case Insensitive
    $where = "t.%s ";
    $flag = 'i'; //ci flag for use in php preg_search and preg_replace
  }

  $preceded_php = '';
  if (!empty($preceded)) {
    if (!$regex) {
      $preceded = addcslashes($preceded, SCANNER_REGEX_CHARS);
    }
    $preceded_php = '(?<='. $preceded .')';
  }
  $followed_php = '';
  if (!empty($followed)) {
    if (!$regex) {
      $followed = addcslashes($followed, SCANNER_REGEX_CHARS);
    }
    $followed_php = '(?='. $followed .')';
  }

  //Case 1:
  if ($wholeword && $regex) {
    $where .= "REGEXP '[[:<:]]%s[[:>:]]'";
    $search_db = $preceded . $search . $followed;
    $search_php = '\b'. $preceded_php . $search . $followed_php .'\b';
  }
  //Case 2:
  else if ($wholeword && !$regex) {
    $where .= "REGEXP '[[:<:]]%s[[:>:]]'";
    $search_db = $preceded . addcslashes($search, SCANNER_REGEX_CHARS) . $followed;
    $search_php = '\b'. $preceded_php . addcslashes($search, SCANNER_REGEX_CHARS) . $followed_php .'\b';
  }
  //Case 3:
  else if (!$wholeword && $regex) {
    $where .= "REGEXP '%s'";
    $search_db = $preceded . $search . $followed;
    $search_php = $preceded_php . $search . $followed_php;
  }
  //Case 4:
  else { //!wholeword and !regex:
    $where .= "REGEXP '%s'";
    $search_db = $preceded . addcslashes($search, SCANNER_REGEX_CHARS) . $followed;
    $search_php = $preceded_php . addcslashes($search, SCANNER_REGEX_CHARS) . $followed_php;
  }

  //if terms selected, then put together extra join and where clause:
  $join = '';
  if (is_array($terms) && count($terms)) {
    $terms_where = array();
    $terms_params = array();
    foreach ($terms as $term) {
      $terms_where[] = 'tn.tid = %d';
      $terms_params[] = $term;
    }
    $join = 'INNER JOIN {term_node} tn ON t.nid = tn.nid';
    $where .= ' AND ('. implode(' OR ', $terms_where) .')';
  }

  if ($published) {
    $where .= ' AND n.status = 1 ';
  }

  $tables_map = _scanner_get_selected_tables_map();

  foreach ( $tables_map as $map ) {
    
784
785
    $table = $map['table'];
    $field = $map['field'];
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
    $type  = $map['type'];
    $on    = $map['on'] ? $map['on'] : 'vid';

    $query_params = array($field, $table, $on, $on, $type, $field, $search_db);
    if (!empty($join)) {
      $query_params = array_merge($query_params, $terms_params);
    }

    $result = db_query("
      SELECT t.%s as content, t.nid, n.title
      FROM {%s} t
      INNER JOIN {node} n ON t.%s = n.%s
      $join
      WHERE n.type = '%s' AND $where
    ", $query_params);

    while ($row = db_fetch_object($result)) {
      $content = $row->content;
804
805
      $matches = array();
      $text = '';
806
807
808
809

      // checking for possible timeout
      // if within 5 seconds of timeout - attempt to expand environment
      if (time() >= ($start_time + $max_execution_time - 5)) {
810
        if (!$expanded) {
811
812
813
814
815
          if ($user->uid > 0) {
            $verbose = TRUE;
          }
          else {
            $verbose = FALSE;
816
          }
817
818
819
          if (_scanner_change_env('max_execution_time', '600', $verbose)) {
            drupal_set_message(t('Default max_execution_time too small and changed to 10 minutes.'), 'error');
            $max_execution_time = 600;
820
          }
821
822
823
824
825
          $expanded = TRUE;
        }
        // if expanded environment still running out of time - shutdown process
        else {
          $shutting_down = TRUE;
826
827
          variable_set('scanner_partially_processed_'. $user->uid, $processed);
          variable_set('scanner_partial_undo_'. $user->uid, $undo_data);
828
829
          if ($searchtype == 'search') {
            drupal_set_message(t('Did not have enough time to complete search.'), 'error');
830
831
          }
          else {
832
            drupal_set_message(t('Did not have enough time to complete. Please re-submit replace'), 'error');
833
834
          }
          break 2;
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

      /*
       * SEARCH
       */
      if ($searchtype == 'search') {
        //pull out the terms and highlight them for display in search results:
        $regexstr = "/(.{0,130}?)($search_php)(.{0,130})/$flag";
        $hits = preg_match_all($regexstr, $content, $matches, PREG_SET_ORDER);
        if ($hits > 0) {
          foreach ( $matches as $match ) {
            if ( $match[1] ) {
              $text .= '...'. htmlentities($match[1], ENT_COMPAT, 'UTF-8');
            }
            $text .= '<strong>'. htmlentities($match[2], ENT_COMPAT, 'UTF-8') .'</strong>';
            if ( $match[3] ) {
              $text .= htmlentities($match[3], ENT_COMPAT, 'UTF-8') .'...';
            }
          }
        }
        else {
          $text = "<div class='warning'>" . t("Can't display search result due to conflict between search term and internal preg_match_all function.") .'</div>';
        }

        $results[] = array(
          'title' => $row->title,
          'type' => $type,
          'count' => $hits,
          'field' => $field,
          'nid' => $row->nid,
          'text' => $text,
        );
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
      /*
       * REPLACE
       * + check to see if already processed
       */
      else if (!isset($processed[$field][$row->nid])) {
        $hits = 0;
        $newcontent = preg_replace("/$search_php/$flag", $replace, $content, -1, $hits);

        $thenode = node_load(array('nid' => $row->nid));

        //see if we're dealing with a CCK text field and therefore need to strip the
        // "_value" off the end:
        preg_match('/(.+)_value$/', $field, $matches);
        if (empty($matches[0])) { //if not CCK text field:
          $thenode->$field = $newcontent;
        }
        else {
          //Is this the best way to copy the new content back into the node's CCK field???
          $tmpstr = ('$thenode->'. $matches[1] .'[0]["value"] = $newcontent;');
          eval($tmpstr);
        }

        // NOTE: a revision only created for the first change of the node.
        // subsequent changes of the same node do not generate additional revisions:
        if (!isset($undo_data[$thenode->nid]['new_vid'])) {
          $thenode->revision = TRUE;
          $thenode->log = t('@name replaced %search with %replace via Scanner Search and Replace module.', array('@name' => $user->name, '%search' => $search, '%replace' => $replace));
          $undo_data[$thenode->nid]['old_vid'] = $thenode->vid;
        }

        if (variable_get('scanner_rebuild_teasers', 1)) {
          $thenode->teaser = node_teaser($thenode->body, $thenode->format);
        }
        node_save($thenode);

        // array to log completed fields in case of shutdown
        $processed[$field][$row->nid] = TRUE;
        
        // undo data construction
        $undo_data[$thenode->nid]['new_vid'] = $thenode->vid; //now set to updated vid after node_save()
        $results[] = array(
          'title' => $thenode->title,
          'type' => $thenode->type,
          'count' => $hits,
          'field' => $field,
          'nid' => $thenode->nid,
        );

Tao Starbow's avatar
Tao Starbow committed
918
      }
919
920
921
922
923

    } //end while
  } //end foreach
  
  // if completed
924
  if (!$shutting_down) {
925
926
    variable_del('scanner_partially_processed_'. $user->uid);
    variable_del('scanner_partial_undo_'. $user->uid);
927
928
929
930
931
932
933
  }

  if ($searchtype == 'search') {
    return theme('scanner_results', $results);
  }
  else { //searchtype == 'replace'
    if (count($undo_data) && !$shutting_down) {
934
      db_query('INSERT INTO {scanner} (undo_data, undone, searched, replaced, count, time) VALUES ("%s", %d, "%s", "%s", %d, %d)', serialize($undo_data), 0, $search, $replace, count($undo_data), time());
Tao Starbow's avatar
Tao Starbow committed
935
    }
936
937

    return theme('scanner_replace_results', $results);
938
939
940
  }
}

941

Tao Starbow's avatar
Tao Starbow committed
942
943
944
945
// ***************************************************************************
// Settings ******************************************************************
// ***************************************************************************

946
947
948
949
950
951
952
/**
 * Search and Replace Settings form.
 *
 * @return $form
 */
function scanner_admin_form() {
  drupal_set_title('Scanner Settings');
953

954
  $table_map = _scanner_get_selected_tables_map();
955
956
957
958
959
  sort($table_map);
  foreach ($table_map as $item) {
    $output .= '<li><b>'. $item['type'] .':</b> '. $item['field'];
    if ( $item['on'] ) {
      $output .= t('on !on', array('!on' => $item['on']));
Tao Starbow's avatar
Tao Starbow committed
960
961
    }
    $output .= '</li>';
962
  }
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978

  $form['selected'] = array(
    '#type' => 'fieldset',
    '#title' => t('Current Settings'),
    '#collapsible' => TRUE,
  );

  $form['selected']['info']['#value'] = '<p>Fields that will be searched (in [nodetype: fieldname] order):</p><ul>'. $output .'</ul>';


  $form['settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Scanner Options'),
    '#collapsible' => TRUE,
  );

Tao Starbow's avatar
Tao Starbow committed
979
  $form['settings']['scanner_mode'] = array(
980
981
982
    '#type' => 'checkbox',
    '#title' => t('Default: Case Sensitive Search Mode'),
    '#default_value' => variable_get('scanner_mode', 0),
Tao Starbow's avatar
Tao Starbow committed
983
  );
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000

  $form['settings']['scanner_wholeword'] = array(
    '#type' => 'checkbox',
    '#title' => t('Default: Match Whole Word'),
    '#default_value' => variable_get('scanner_wholeword', 0),
  );

  $form['settings']['scanner_regex'] = array(
    '#type' => 'checkbox',
    '#title' => t('Default: Regular Expression Search'),
    '#default_value' => variable_get('scanner_regex', 0),
  );

  $form['settings']['scanner_published'] = array(
    '#type' => 'checkbox',
    '#title' => t('Default: Search Published Nodes Only'),
    '#default_value' => variable_get('scanner_published', 1),