summaryrefslogtreecommitdiff
path: root/web-ui/public/js/search/results_highlighter.js
blob: 831be0cd802abc58045ba5374f028a92f6d58c5e (plain)
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
/*
 * Copyright (c) 2014 ThoughtWorks, Inc.
 *
 * Pixelated is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Pixelated is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Pixelated. If not, see <http://www.gnu.org/licenses/>.
 */

define(
  [
    'flight/lib/component',
    'page/events'
  ], function (defineComponent, events) {

    'use strict';

    return defineComponent(resultsHighlighter);

    function resultsHighlighter(){
      this.defaultAttrs({
        keywords: []
      });

      this.getKeywordsSearch = function (event, data) {
        this.attr.keywords = data.query.split(' ').map(function(keyword) {
          return keyword.toLowerCase();
        });
      };

      this.highlightResults = function (event, data) {
        var domIdent = data.where;
        if(this.attr.keywords) {
          _.each(this.attr.keywords, function (keyword) {
            keyword = escapeRegExp(keyword);
            $(domIdent).highlightRegex(new RegExp(keyword, 'i'), {
              tagType:   'em',
              className: 'search-highlight'
            });
          });
        }
      };

      this.clearHighlights = function (event, data) {
        this.attr.keywords = [];
        _.each($('em.search-highlight'), function(highlighted) {
          var jqueryHighlighted = $(highlighted);
          var text = jqueryHighlighted.text();
          jqueryHighlighted.replaceWith(text);
        });
      };

      this.highlightString = function (string) {
        _.each(this.attr.keywords, function (keyword) {
          keyword = escapeRegExp(keyword);
          var regex = new RegExp('(' + keyword + ')', 'ig');
          string = string.replace(regex, '<em class="search-highlight">$1</em>');
        });
        return string;
      };

      /*
       * Alter data.mail.textPlainBody to highlight each of this.attr.keywords
       * and pass it back to the mail_view when done
       */
      this.highlightMailContent = function(ev, data){
        var mail = data.mail;
        mail.textPlainBody = this.highlightString(mail.textPlainBody);
        this.trigger(document, events.mail.display, data);
      };

      /*
       * Escapes the special charaters used regular expressions that
       * would cause problems with strings in the RegExp constructor
       */
      function escapeRegExp(string){
        return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
      }

      this.after('initialize', function () {
        this.on(document, events.search.perform, this.getKeywordsSearch);
        this.on(document, events.ui.tag.select, this.clearHighlights);
        this.on(document, events.search.resetHighlight, this.clearHighlights);

        this.on(document, events.search.highlightResults, this.highlightResults);
        this.on(document, events.mail.highlightMailContent, this.highlightMailContent);
      });
    }
});