Daniel Buschke

Directory Watcher

Scroll down for an English description!

Sicherlich kennen viele die Windows Home Server Add-In Idea Challenge 2009, welche durch das HSB-Team und dem WGS-Team ins Leben gerufen wurde. Hierbei wurden einige sehr interessante Ideen eingereicht und die beste Idee wurde in einer langwierigen Abstimmungsphase ermittelt.
Nun habe ich mir vor kurzem das Dokument mit den Top 10 der eingereichten Ideen angesehen und bin auf den Vorschlag von Adam Swift gestoßen - "Folder Monitor + Notification scheme".

Diese kleine Idee hatte ich schnell verinnerlicht und wollte sie umsetzen. Denn warum sollte es nur das eine "Gewinner-Add-In" geben!?

Hierbei ist nun mein viertes Add-In entstanden, welche die folgenden Funktionen beinhaltet. (Kommentare und Bugmeldungen wie immer hier)

Einsatzzweck:

Ermöglicht wird mit diesem Add-In die Überwachung beliebiger Ordner auf dem Home Server, z.B. für Erinnerungen nach fertig gestellten Downloads oder bei Ablage von Dateien in User Verzeichnissen.
Da bei einem überwachten Ordner auch gleichzeitig alle Unterordner mit überwacht werden, können Personen Dateien in ihrem Userverzeichnis ablegen und man wird per Email darüber benachrichtigt.
Kommt man gerade nicht an sein Emailpostfach, so kann über die öffentliche Webseite der Feed mit allen Änderungen abgerufen werden.

Funktionsweise:

Das Add-In liefert eine Konfigurationsoberfläche, die Ansicht "Settings", in der sich folgende Einstellungen tätigen lassen
  • Erfassung der zu überwachenden Ordner
  • Festlegen von Dateitypen, welche überwacht werden sollen seit Version 1.1 ist auch das ausschließen von Dateitypen möglich
  • Art der Benachrichtigung (Client Notification, RSS Feed, Email)
  • Statusanzeige des Services
  • Anzahl Tage, wie lange die Überwachung loggen soll
  • Pflege der Emaildaten
  • neu seit Version 1.1 - Tageszusammenfassung der Aktivitäten
In der Ansicht "View" werden alle gelöschten oder erstellten Dateien nach Datum gruppiert und sortiert angezeigt.
Der Button "check updates" prüft, wie ist es anders zu erwarten, ob eventuell eine neue Version zum download bereit steht.

Anleitung:

Nach erfolgreicher Installation und Konfiguration steht die Überwachung für die konfigurierten Ordner zur Verfügung. Überwacht wird das löschen und anlegen von Dateien, nicht jedoch das verändern oder umbenennen! Wird eine dieser beiden Aktionen erkannt, wird diese Aktion geloggt und die konfigurierten Benachrichtigungsoptionen abgearbeitet.
Emailversand: eine Email wird an die eingestellte Emailadresse verschickt in Version 1.1 mehrere Emailadressen pro Ordner
Feed: der Feed wird aktualisiert (zu finden unter https://DEINNAME.homeserver.com/home/rss.xml und intern unter https://DEINNAME.homeserver.com/remote/rss.aspx) in Version 1.1 neue interner Feed
Client notification: es wird eine Warnungsmeldung generiert, diese erscheint über das TrayIcon der Homeserver Konsole auf allen angemeldeten Clients in Version 1.1 entfernt

Fotostrecke:

Directory Watcher View Directory Watcher Settings


Download:

WHSDirectoryWatcherInstaller

Dokumentation:

Directory Watcher Kurzdokumentation

Video:

Video ansehen



Versionshistorie:

v1.0.0.0 - erstes öffentliches Release


Fehler:

Feed kann nicht erstellt werden / Service stürzt ab
betrifft alle nicht englischen WHS Varianten

beim öffnen der Konsole kommt eine NullReferenceException beim initialisieren des Watchers
kein Fehler des Add-Ins - prüfen ob Power Pack 2 installiert ist / Application Folder kann nicht erstellt werden

flackern der Auflistung, wenn eine neue Datei hinzugefügt oder gelöscht wird
Schönheitsfehler

Button Testmail ohne Funktion


Wunschliste von Benutzern / Vorschau:
  • ---

v1.1.0.0

  • Unterstützung Deutsch
  • RSS Feed intern
  • Flackern bei Reload - eingeschränkt
  • Testmail kann nun verschickt werden
  • Ersteller einer Datei wird in Emails angezeigt
  • Meldungen werden mit QMessagebox ausgegeben
  • Fehler bei deutschem WHS Feederstellung(extern) gefixt
  • Exclude von Dateiendungen möglich
  • Benachrichtigungen "sammeln" (z.B. nur 1x woche / 1x täglich)
  • Client Notification entfernt
  • SSL möglich
  • Konfiguration mehrerer Emailadressen zu einem überwachten Ordner möglich
  • je Ordner kann ein anschließender Prozess ausgeführt werden (z.B. Batchdatei)

v1.1.0.1

  • Fehler Emailversand bei Unterordnern behoben

Directory Watcher



Many of you are probably familiar with the Windows Home Server Add-in Idea Challenge 2009 launched by the HSB-Team and WGS-Team. Some very interesting ideas were submitted and the best idea was evaluated throughout a lengthy consultation period.
Now, I recently went through the document of the top 10 entries and came across a proposal by Adam Swift - "Folder Monitor + Notification scheme".

This neat idea immediately fascinated me, so I went ahead to implement it. Besides, why should there be only one "winner-add-in" anyways!?

Well, I turned it into my fourth add-in, including the following features. (As always, comments and bug reports here)

Purpose:

The add-in provides the capability to monitor any folder on the home server, e.g. for completed downloads, or storage of files in defined user directories. A folder will not only be monitored by itself, all subdirectories are automatically included by the service as well. For this reason, users may save files to any location within their user directory and you will automatically be notified by email about any file changes. In case the addressed email account is unavailable, you may retrieve a feed on the public website informing on all the changes.

How it works:

The add-in provides a "Settings" interface, you need to configure:
  • set the folder to be monitored
  • define file types, which are to be monitored since version 1.1 exclude by file extensions possible
  • select the type of notification (Notification to clients, RSS feed, email)
  • read off the status of the service
  • define the number of days to log events
  • define email settings
  • since version 1.1 - daily notification summary
The "View" page displays all deleted or created files, grouped and sorted by date. The "check updates" button checks for any relevant file changes.

Instructions:

After successful installation and configuration, the monitoring service is available for the configured folder. The monitoring automatically detects newly created or deleted files, but does not take notice of changes to existing files, renaming in particular! If it detects either a create or delete event, the action is logged, and the configured notification options will execute.
Email delivery: An email is sent to the configured email address since version 1.1 more than one address per folder possible
Feed: The feed is updated (found at https://YourName.homeserver.com/home/rss.xml and internally https://YourName.homeserver.com/remote/rss.aspx) since version 1.1 new internal feed
Client notification: it generates a warning message that appears on the tray icon of the Home Server Console on all registered clientssince version 1.1 removed

Pictures:

Directory Watcher View Directory Watcher Settings


Download:

WHSDirectoryWatcherInstaller

Documentation:

Directory Watcher short documentation (german)

Video:

watch video



Version history:

v1.0.0.0 - first release


Issues:

feed can't be created / service crash
affects all non-english versions of WHS

opening the console comes with a NullReferenceException when initializing the watcher
no fault of the add-in - consider whether or not Power Pack 2 is installed / Application folder can't be created

flicker of the collection, when a new file is added or deleted
Blemishes

Button Testmail without function


Wish list of users / Preview:
  • ---

v1.1.0.0

  • supports german
  • RSS feed internally
  • flicker limited by reload
  • testmail will now work
  • Creator will be shown by mail
  • Messages with QMessagebox
  • Fixed bug in feed production
  • Exclude by file extensions possible
  • Notifications collect (e.g., only 1x week / 1x daily)
  • client notification removed
  • SSL possible
  • Configuration of multiple email addresses to a monitored folder possible
  • each folder can be executed a subsequent process (e.g. batch file)

v1.1.0.1

  • Email delivery error corrected in subfolders



dbuschke Feed Share on Twitter Share on Facebook dbuschke on youtube