Mute notifications

refactor handling

changedetectionio/__init__.py

@@ -370,20 +370,20 @@ def changedetection_app(config=None, datastore_o=None):
         from changedetectionio import forms
 
         limit_tag = request.args.get('tag')
-        pause_uuid = request.args.get('pause')
-
         # Redirect for the old rss path which used the /?rss=true
         if request.args.get('rss'):
             return redirect(url_for('rss', tag=limit_tag))
 
-        if pause_uuid:
+        op = request.args.get('op')
-            try:
+        if op:
-                datastore.data['watching'][pause_uuid]['paused'] ^= True
+            uuid = request.args.get('uuid')
-                datastore.needs_write = True
+            if op == 'pause':
+                datastore.data['watching'][uuid]['paused'] ^= True
+            elif op == 'mute':
+                datastore.data['watching'][uuid]['notification_muted'] ^= True
 
-                return redirect(url_for('index', tag = limit_tag))
+            datastore.needs_write = True
-            except KeyError:
+            return redirect(url_for('index', tag = limit_tag))
-                pass
 
         # Sort by last_changed and add the uuid which is usually the key..
         sorted_watches = []

changedetectionio/model/Watch.py

@@ -36,6 +36,7 @@ class model(dict):
             'notification_title': default_notification_title,
             'notification_body': default_notification_body,
             'notification_format': default_notification_format,
+            'notification_muted': False,
             'css_filter': '',
             'extract_text': [],  # Extract text by regex after filters
             'subtractive_selectors': [],

changedetectionio/static/styles/styles.css

@@ -271,13 +271,15 @@ footer {
 #new-version-text a {
   color: #e07171; }
 
-.watch-controls.state-False img {
+.watch-controls {
-  opacity: 0.2;
+  /* default */ }
-  transition: opacity 0.3s; }
+  .watch-controls .state-on img {
-
+    opacity: 0.8; }
-.watch-controls img:hover {
+  .watch-controls img {
-  transition: opacity 0.3s;
+    opacity: 0.2; }
-  opacity: 0.8; }
+  .watch-controls img:hover {
+    transition: opacity 0.3s;
+    opacity: 0.8; }
 
 .monospaced-textarea textarea {
   width: 100%;

changedetectionio/static/styles/styles.scss

@@ -363,16 +363,24 @@ footer {
 }
 
 .watch-controls {
-  &.state-False img {
+  .state-on {
+    img {
+      opacity: 0.8;
+    }
+  }
+
+  /* default */
+  img {
     opacity: 0.2;
-    transition: opacity 0.3s;
   }
+
   img {
     &:hover {
       transition: opacity 0.3s;
       opacity: 0.8;
     }
   }
+
 }
 
 .monospaced-textarea {

changedetectionio/templates/watch-overview.html

@@ -56,11 +56,10 @@
                 {% if watch.newest_history_key| int > watch.last_viewed and watch.history_n>=2 %}unviewed{% endif %}
                 {% if watch.uuid in queued_uuids %}queued{% endif %}">
                 <td class="inline">{{ loop.index }}</td>
-                <td class="inline paused-state state-{{watch.paused}} watch-controls">
+                <td class="inline watch-controls">
-                    <a href="{{url_for('index', pause=watch.uuid, tag=active_tag)}}"><img src="{{url_for('static_content', group='images', filename='pause.svg')}}" alt="Pause checks" title="Pause checks"/></a>
+                    <a class="state-{{'on' if watch.paused }}" href="{{url_for('index', op='pause', uuid=watch.uuid, tag=active_tag)}}"><img src="{{url_for('static_content', group='images', filename='pause.svg')}}" alt="Pause checks" title="Pause checks"/></a>
-                    <a href="{{url_for('index', pause=watch.uuid, tag=active_tag)}}"><img src="{{url_for('static_content', group='images', filename='bell-off.svg')}}" alt="Mute notifications" title="Mute notifications"/></a>
+                    <a class="state-{{'on' if watch.notification_muted}}" href="{{url_for('index', op='mute', uuid=watch.uuid, tag=active_tag)}}"><img src="{{url_for('static_content', group='images', filename='bell-off.svg')}}" alt="Mute notifications" title="Mute notifications"/></a>
                 </td>
-
                 <td class="title-col inline">{{watch.title if watch.title is not none and watch.title|length > 0 else watch.url}}
                     <a class="external" target="_blank" rel="noopener" href="{{ watch.url.replace('source:','') }}"></a>
                     <a href="{{url_for('form_share_put_watch', uuid=watch.uuid)}}"><img style="height: 1em;display:inline-block;" src="{{url_for('static_content', group='images', filename='spread.svg')}}" /></a>

changedetectionio/update_worker.py

@@ -21,6 +21,63 @@ class update_worker(threading.Thread):
         self.datastore = datastore
         super().__init__(*args, **kwargs)
 
+    def send_content_changed_notification(self, uuid):
+        n_object = {}
+        watch = self.datastore.data['watching'].get(uuid, False)
+        if not watch:
+            return
+
+        watch_history = watch.history
+        dates = list(watch_history.keys())
+        # Theoretically it's possible that this could be just 1 long,
+        # - In the case that the timestamp key was not unique
+        if len(dates) == 1:
+            raise ValueError(
+                "History index had 2 or more, but only 1 date loaded, timestamps were not unique? maybe two of the same timestamps got written, needs more delay?"
+            )
+
+        # Did it have any notification alerts to hit?
+        if len(watch['notification_urls']):
+            print(">>> Notifications queued for UUID from watch {}".format(uuid))
+            n_object['notification_urls'] = watch['notification_urls']
+            n_object['notification_title'] = watch['notification_title']
+            n_object['notification_body'] = watch['notification_body']
+            n_object['notification_format'] = watch['notification_format']
+
+        # No? maybe theres a global setting, queue them all
+        elif len(self.datastore.data['settings']['application']['notification_urls']):
+            print(">>> Watch notification URLs were empty, using GLOBAL notifications for UUID: {}".format(uuid))
+            n_object['notification_urls'] = self.datastore.data['settings']['application']['notification_urls']
+            n_object['notification_title'] = self.datastore.data['settings']['application']['notification_title']
+            n_object['notification_body'] = self.datastore.data['settings']['application']['notification_body']
+            n_object['notification_format'] = self.datastore.data['settings']['application']['notification_format']
+        else:
+            print(">>> NO notifications queued, watch and global notification URLs were empty.")
+
+        # Only prepare to notify if the rules above matched
+        if 'notification_urls' in n_object:
+            # HTML needs linebreak, but MarkDown and Text can use a linefeed
+            if n_object['notification_format'] == 'HTML':
+                line_feed_sep = "</br>"
+            else:
+                line_feed_sep = "\n"
+
+            from changedetectionio import diff
+
+            snapshot_contents = ''
+            with open(watch_history[dates[-1]], 'rb') as f:
+                snapshot_contents = f.read()
+
+            n_object.update({
+                'watch_url': watch['url'],
+                'uuid': uuid,
+                'current_snapshot': snapshot_contents.decode('utf-8'),
+                'diff': diff.render_diff(watch_history[dates[-2]], watch_history[dates[-1]], line_feed_sep=line_feed_sep),
+                'diff_full': diff.render_diff(watch_history[dates[-2]], watch_history[dates[-1]], True, line_feed_sep=line_feed_sep)
+            })
+
+            self.notification_q.put(n_object)
+
     def send_filter_failure_notification(self, uuid):
 
         threshold = self.datastore.data['settings']['application'].get('filter_failure_notification_threshold_attempts')
@@ -105,8 +162,10 @@ class update_worker(threading.Thread):
                                                                                            0)
                             print("Filter for {} not found, consecutive_filter_failures: {}".format(uuid, c))
                             if threshold > 0 and c >= threshold:
-                                self.send_filter_failure_notification(uuid)
+                                if self.datastore.data['watching'][uuid].get('notification_muted'):
+                                    self.send_filter_failure_notification(uuid)
                                 c = 0
+
                             self.datastore.update_watch(uuid=uuid, update_obj={'consecutive_filter_failures': c})
 
                         process_changedetection_results = True
@@ -143,66 +202,21 @@ class update_worker(threading.Thread):
                             # For the FIRST time we check a site, or a change detected, save the snapshot.
                             if changed_detected or not watch['last_checked']:
                                 # A change was detected
-                                fname = watch.save_history_text(contents=contents, timestamp=str(round(time.time())))
+                                watch.save_history_text(contents=contents, timestamp=str(round(time.time())))
 
                             self.datastore.update_watch(uuid=uuid, update_obj=update_obj)
 
                             # A change was detected
                             if changed_detected:
-                                n_object = {}
                                 print (">> Change detected in UUID {} - {}".format(uuid, watch['url']))
 
                                 # Notifications should only trigger on the second time (first time, we gather the initial snapshot)
                                 if watch.history_n >= 2:
                                     # Atleast 2, means there really was a change
                                     self.datastore.update_watch(uuid=uuid, update_obj={'last_changed': round(now)})
+                                    if not self.datastore.data['watching'][uuid].get('notification_muted'):
+                                        self.send_content_changed_notification(self, uuid)
 
-                                    watch_history = watch.history
-                                    dates = list(watch_history.keys())
-                                    # Theoretically it's possible that this could be just 1 long,
-                                    # - In the case that the timestamp key was not unique
-                                    if len(dates) == 1:
-                                        raise ValueError(
-                                            "History index had 2 or more, but only 1 date loaded, timestamps were not unique? maybe two of the same timestamps got written, needs more delay?"
-                                        )
-                                    prev_fname = watch_history[dates[-2]]
-
-                                    # Did it have any notification alerts to hit?
-                                    if len(watch['notification_urls']):
-                                        print(">>> Notifications queued for UUID from watch {}".format(uuid))
-                                        n_object['notification_urls'] = watch['notification_urls']
-                                        n_object['notification_title'] = watch['notification_title']
-                                        n_object['notification_body'] = watch['notification_body']
-                                        n_object['notification_format'] = watch['notification_format']
-
-                                    # No? maybe theres a global setting, queue them all
-                                    elif len(self.datastore.data['settings']['application']['notification_urls']):
-                                        print(">>> Watch notification URLs were empty, using GLOBAL notifications for UUID: {}".format(uuid))
-                                        n_object['notification_urls'] = self.datastore.data['settings']['application']['notification_urls']
-                                        n_object['notification_title'] = self.datastore.data['settings']['application']['notification_title']
-                                        n_object['notification_body'] = self.datastore.data['settings']['application']['notification_body']
-                                        n_object['notification_format'] = self.datastore.data['settings']['application']['notification_format']
-                                    else:
-                                        print(">>> NO notifications queued, watch and global notification URLs were empty.")
-
-                                    # Only prepare to notify if the rules above matched
-                                    if 'notification_urls' in n_object:
-                                        # HTML needs linebreak, but MarkDown and Text can use a linefeed
-                                        if n_object['notification_format'] == 'HTML':
-                                            line_feed_sep = "</br>"
-                                        else:
-                                            line_feed_sep = "\n"
-
-                                        from changedetectionio import diff
-                                        n_object.update({
-                                            'watch_url': watch['url'],
-                                            'uuid': uuid,
-                                            'current_snapshot': contents.decode('utf-8'),
-                                            'diff': diff.render_diff(prev_fname, fname, line_feed_sep=line_feed_sep),
-                                            'diff_full': diff.render_diff(prev_fname, fname, True, line_feed_sep=line_feed_sep)
-                                        })
-
-                                        self.notification_q.put(n_object)
 
                         except Exception as e:
                             # Catch everything possible here, so that if a worker crashes, we don't lose it until restart!