Benutzerbenachrichtigungen

dominik4545 · February 3, 2016 at 7:15 PM

hallo zusammen,

in meinem Plugin gibt es die Möglichkeit in verschiedensten Kategorien Einträge zu erstellen. Jetzt würde ich gerne die Benutzer bei neuen/geänderte Einträgen benachrichtigen. Dazu habe ich gesehen, dass es "user notification events" gibt, welche man zu einem Stack zusammenfassen kann.

Dazu hätte ich zwei Fragen:

ist es möglich pro Kategorie einen Stack zu machen? Wenn ja, wie müsste das dann programmtechnisch aussehen?
Wie funktioniert das mit dem abonnieren genau? Das Reverse Engineering hat mich da nicht zu 100 % weiter gebracht

Wäre super, wenn mir jemand helfen könnte

Viele Grüße und schönen Abend
Dominik

**Alexander Ebert** · February 5, 2016 at 1:06 AM Official Post

Quote from dominik4545

ist es möglich pro Kategorie einen Stack zu machen? Wenn ja, wie müsste das dann programmtechnisch aussehen?

Klar, genau das ist ja der Sinn vom Stacking. Relevent ist dafür der Event-Hash (getEventHash()), dieser wird vom Event bereitgestellt und erlaubt es WCF automatisch zu entscheiden ob eine neue Notification erzeugt wird oder aber das Stacking zum Einsatz kommt.

Quote from dominik4545

Wie funktioniert das mit dem abonnieren genau? Das Reverse Engineering hat mich da nicht zu 100 % weiter gebracht

Das läuft alles über den UserObjectWatchHandler, eine Referenzimplementierung findest du in Burning Board, aufgerufen etwa in PostEditor::triggerPublication().

dominik4545 · February 5, 2016 at 10:13 PM

Habe die Funktion, die Du erwähnt hattest, gefunden. Darin wird im Beispiel folgendes aufgerufen:

PHP: PostAction.class.php

// update watched objects
				if (!$post->isDeleted) {
					UserObjectWatchHandler::getInstance()->updateObject('com.woltlab.wbb.thread', $threadEditor->threadID, 'post', 'com.woltlab.wbb.post', new PostUserNotificationObject($post->getDecoratedObject()));
				}

im PostUserNotificationObject jedoch steht nichts über die eigentliche Benachrichtigung, sondern lediglich über Informationen zum übergebenen Post in diesem Falle. Was ist noch nötig, um z.B. eine Benachrichtung, wie folgende zu erreichen (und dabei eben das Stacking je Kategorie durchzuführen)?

Außerdem habe ich herausgefunden, dass das 'post' (übergeben hier) in der userNotificationEvent.xml vorkommt. Wofür wird das benötigt? Spielt das mit einer weiteren PHP-Klasse zusammen?

Sorry für die doofen Fragen, aber irgendwie steh ich diesbezüglich gerade ziemlich auf dem Schlauch

Viele Grüße & schönen Freitagabend
Dominik

Fighter456 · February 5, 2016 at 10:20 PM

Der UserObjectWatchHandler hat nichts mit den Benachrichtigungen zu tun. Du suchst den UserNotificationHandler.
Du brauchst eine Klasse, die das Interface IUserNotificationEvent bzw. von AbstractUserNotificationEvent erbt.
Der Eintrag in der userNotificationEvent.xml ist dazu da, um das Benachrichtigungsevent im System zu registrieren. Sonst wüsste der UserNotificationHandler nicht was er machen soll.

dominik4545 · February 6, 2016 at 11:43 AM

Super, vielen Dank!
Was heißt denn die Option preset in der userNotificationEvent.xml? Ist das der Anzeiger, ob die Option beim Benutzer im Profil standardmäßig aktiviert sein soll?

Dann hätte ich nur noch als Frage, was denn dann der UserObjectWatchHandler macht. Ist der dafür da, dass Benutzer sich Themen (oder in meinem Fall Kategorien) abonnieren können? Sollte dies der Fall sein, würde ich schätzungsweise doch auf diesen zurückgreifen.

**Alexander Ebert** · February 6, 2016 at 1:02 PM Official Post

Quote from dominik4545

Was heißt denn die Option preset in der userNotificationEvent.xml? Ist das der Anzeiger, ob die Option beim Benutzer im Profil standardmäßig aktiviert sein soll?

Korrekt.

Quote from dominik4545

Dann hätte ich nur noch als Frage, was denn dann der UserObjectWatchHandler macht. Ist der dafür da, dass Benutzer sich Themen (oder in meinem Fall Kategorien) abonnieren können? Sollte dies der Fall sein, würde ich schätzungsweise doch auf diesen zurückgreifen.

Du brauchst ihn auch, denn er verwaltet die Logik hinter Abos. Der UserObjectWatchHandler selbst nutzt aber das Benachrichtigungssystem und daher brauchst du beides.

dominik4545 · February 7, 2016 at 10:17 AM

Okay - vielen Dank!
Dann werde ich das die Tage einmal ausprobieren und für diejenigen, die auch soetwas vor haben die Ergebnisse hier posten.

dominik4545 · February 10, 2016 at 1:31 PM

Hallo zusammen,

ich bin nun so weit gekommen, dass pro Dateiupload in eine meiner Kategorien eine Benachrichtigung erstellt wird. Ziel von mir war es jedoch, pro Kategorie alle Dateiuploads zu schachteln.
Woran liegt das bzw. was müsste ich ändern, um das zu erreichen?
@Alexander Ebert: Du meintest etwas bzgl. der Methode getEventHash(). Wird diese verwendet, um z.B. das Stacking durchzuführen? Bei mir sieht diese aktuell so aus:

PHP

/**
	 * @see    \wcf\system\user\notification\event\AbstractUserNotificationEvent::getEventHash()
	 */
	public function getEventHash(){
	    return sha1($this->eventID.'-'.$this->userNotificationObject->getObjectID());
	}

Das userNotificationObject ist die hochgeladene Datei. Wenn ich die ID der Kategorie verwende, in welches die Datei hochgeladen wurde, wird die bestehende Notification nicht geändert, aber auch keine neue erzeugt.

Wo liegt mein Fehler?

Hier ist einmal meine komplette Klasse:

PHP: FileUploadUserNotificationEvent.class.php

<?php
namespace filemanager\system\user\notification\event;
use wcf\system\user\notification\event\AbstractUserNotificationEvent;




class FileUploadUserNotificationEvent extends AbstractUserNotificationEvent {
    /**
     * Event name for upload event
     * 
     * @var     string
     */
    const EVENT_NAME = 'upload';
    /**
     * Object type name for the upload event
     * 
     * @var     string
     */
    const OBJECT_TYPE = 'de.ltb-labs.filemanager.file';




    /**
	 * @see	   \wcf\system\user\notification\event\AbstractUserNotificationEvent::$stackable
	 */
	protected $stackable = true;
	/**
	 * @see    \wcf\system\user\notification\event\IUserNotificationEvent::getTitle()
	 */
	public function getTitle(){
	    return $this->getLanguage()->getDynamicVariable('ltb-labs.filemanager.file.notification.upload.title', array(
	        'file' => $this->userNotificationObject,
	        'timesTriggered' => $this->notification->timesTriggered
	    ));
	}
	/**
	 * @see    \wcf\system\user\notification\event\IUserNotificationEvent::getMessage()
	 */
	public function getMessage(){
	    // fetch authors
	    $authors = $this->getAuthors();
	    // count authors
	    $count = count($authors);
	    // return with prepared message
	    return $this->getLanguage()->getDynamicVariable('ltb-labs.filemanager.file.notification.upload.message', array(
	        'author' => $this->author,
	        'authors' => array_values($authors),
	        'count' => $count,
	        'file' => $this->userNotificationObject,
	        'guestTimesTriggered' => $this->notification->guestTimesTriggered,
	        'others' => $count - 1
	    ));
	}
	/**
	 * @see    \wcf\system\user\notification\event\AbstractUserNotificationEvent::getEmailMessage()
	 */
	public function getEmailMessage($notificationType = 'instant'){
	    return '';
	}
	/**
	 * @see    \wcf\system\user\notification\event\AbstractUserNotificationEvent::getEventHash()
	 */
	public function getEventHash(){
	    return sha1($this->eventID.'-'.$this->userNotificationObject->getVolume()->getObjectID()); // "getVolume()" liefert hier das zugeordnete Volume (Kategorie) zurück
	}
	/**
	 * @see    \wcf\system\user\notification\event\IUserNotificationEvent::getLink()
	 */
	public function getLink(){
	    return $this->userNotificationObject->getURL();
	}
	/**
	 * @see    \wcf\system\user\notification\event\AbstractUserNotificationEvent::checkAccess()
	 */
	public function checkAccess(){
	    return true;
	}
}

Display More

Hinweis: Diese Klasse ist noch nicht fertiggestellt, da ich erst die grundsätzliche Funktionsweise sicherstellen wollte.

Viele Grüße
Dominik

#edit: hat sich erledigt - Fehler gefunden. Sobald es fertig ist, werde ich es als kleines HowTo als eigenes Thema posten und hier verlinken.

dominik4545 · February 10, 2016 at 9:39 PM

Guten Abend zusammen,

jetzt stehe ich leider doch nochmal vor einem Problem, bei welchem ich nicht weiterkomme...
Es funktioniert alles, außer der E-Mail-Versand. Hierbei werden sämtliche Informationen nicht geladen. So bleibt z.B. die notification leer und $this->notification->timesTriggered ergibt 0. Mich verwundert das sehr, da die Benachrichtigung im WCF vollkommend korrekt angezeigt wird. Eventuell könnte sich jemand nochmals meine Klasse anschauen (die jetzt eigentlich fertig wäre ) :

PHP

<?php
namespace filemanager\system\user\notification\event;
use filemanager\data\file\ViewableFile;
use filemanager\system\file\permission\DefaultPermissionValidator;
use filemanager\util\FilemanagerUtil;
use wcf\system\event\EventHandler;
use wcf\system\exception\PermissionDeniedException;
use wcf\system\exception\NamedUserException;
use wcf\system\user\notification\event\AbstractUserNotificationEvent;
use wcf\system\WCF;




/**
 * Represents the upload user notification event for files.
 *
 * @author 	Dominik 
 * @copyright 	2016 LTB-Labs
 * @package 	de.ltb-labs.wcf2.filemanager
 * @subpackage  system.user.notification.event
 */
class FileUploadUserNotificationEvent extends AbstractUserNotificationEvent {

    /**
     * Event name for upload event
     * 
     * @var     string
     */
    const EVENT_NAME = 'upload';

    /**
     * Object type name for the upload event
     * 
     * @var     string
     */
    const OBJECT_TYPE = 'de.ltb-labs.filemanager.file';

    /**
     * Permission validator
     *
     * @var 	\filemanager\system\file\permission\DefaultPermissionValidator
     */
    public $permissionValidator = null;

    /**
     * Permissions which are required in the related volume
     *
     * @var 	array<string>
     */
    public $requiredVolumePermissions = array(
        'canSeeVolume',
        'canOpenVolume'
    );




    /**
	 * @see	   \wcf\system\user\notification\event\AbstractUserNotificationEvent::$stackable
	 */
	protected $stackable = true;

	/**
	 * @see    \wcf\system\user\notification\event\IUserNotificationEvent::getTitle()
	 */
	public function getTitle(){
	    return $this->getLanguage()->getDynamicVariable('ltb-labs.filemanager.file.notification.upload.title', array(
	        'file' => $this->userNotificationObject,
	        'timesTriggered' => $this->notification->timesTriggered
	    ));
	}

	/**
	 * @see    \wcf\system\user\notification\event\IUserNotificationEvent::getMessage()
	 */
	public function getMessage(){
	    return $this->getLanguage()->getDynamicVariable('ltb-labs.filemanager.file.notification.upload.message', array(
	        'author' => $this->getAuthor(),
	        'authors' => $this->getAuthors(), // liefert ordnungsgemäß ein Array mit allen Autoren
	        'file' => $this->userNotificationObject,
	        'formattedAuthors' => FilemanagerUtil::getFormattedAuthors($this->getAuthors(), $this->getLanguage()), // gibt die übergebenen Autoren schön mit HTML-Tags zurück
	        'guestTimesTriggered' => $this->notification->guestTimesTriggered,
	        'timesTriggered' => $this->notification->timesTriggered // liefert ordnungsgemäß die Zahl auf dem Stack
	    ));
	}

	/**
	 * @see    \wcf\system\user\notification\event\AbstractUserNotificationEvent::getEmailMessage()
	 */
	public function getEmailMessage($notificationType = 'instant'){
	    return $this->getLanguage()->getDynamicVariable('ltb-labs.filemanager.file.notification.upload.mail', array(
	        'author' => $this->getAuthor(), 
	        'authors' => $this->getAuthors(), // liefert ein leeres Array!
	        'file' => new ViewableFile($this->userNotificationObject->getDecoratedObject()),
	        'fileType' => $this->userNotificationObject->getFileType(),
	        'formattedAuthors' => FilemanagerUtil::getFormattedAuthors($this->getAuthors(), $this->getLanguage(), false), // 'false' in diesem Aufruf sorgt dafür, dass die Autoren nur mit Namen erwähnt werden und kein vollständiges HTML inkl. Link, etc. verwendet wird
	        'guestTimesTriggered' => $this->notification->guestTimesTriggered,
	        'notificationType' => $notificationType, 
	        'timesTriggered' => $this->notification->timesTriggered // liefert 0!
	    ));
	}

	/**
	 * @see    \wcf\system\user\notification\event\AbstractUserNotificationEvent::getEventHash()
	 */
	public function getEventHash(){
	    return sha1($this->eventID.'-'.$this->userNotificationObject->getVolume()->getObjectID());
	}

	/**
	 * @see    \wcf\system\user\notification\event\IUserNotificationEvent::getLink()
	 */
	public function getLink(){
	    return $this->userNotificationObject->getLink();
	}

	/**
	 * @see    \wcf\system\user\notification\event\AbstractUserNotificationEvent::checkAccess()
	 */
	public function checkAccess(){
	    // init permission validator
	    $this->initFilePermissionValidator();

	    try {
    	    // check volume permissions
    	    $this->userNotificationObject->getVolume()->checkPermission($this->requiredVolumePermissions);

    	    // enable check of owner
    	    $this->permissionValidator->setCheckOwnerEnabled(true);

    	    // disable closed volume check
    	    $this->permissionValidator->setVolumeStateValidationEnabled(false);

    	    // update format of permissions
    	    $this->permissionValidator->setPermissionFormat('can[action][ownerIndicator]Files');

    	    // validate permissions
    	    if(!$this->permissionValidator->isAllowed($this->userNotificationObject->getVolume(), $this->userNotificationObject->isFolder, $this->userNotificationObject->owner, 'view')){
    	        // not allowed to create file here: throw exception
    	        throw new PermissionDeniedException();
    	    }

    	    // permission granted: check whether file exists
    	    if(!@file_exists($this->userNotificationObject->getPath())){
    	        // file does not exist: throw exception
    	        throw new NamedUserException(WCF::getLanguage()->get('ltb-labs.filemanager.file.currentlyUnavailable'));
    	    }

    	    // everything okay: return true
    	    return true;
	    } catch (PermissionDeniedException $e){
	        // permission not granted: return false
	        return false;
	    } catch (NamedUserException $e){
	        // file does not exist: return false
	        return false;
	    }

	    // something else happened: return false
	    return false;
	}

	/**
	 * Initializes the permission validator
	 */
	protected function initFilePermissionValidator(){
	    $this->permissionValidator = new DefaultPermissionValidator(); // Eigene Klasse, die sich um die Validierung der Berechtigungen kümmert. Funktionsweise sichergestellt, da x-fach anderswo verwendet

	    EventHandler::getInstance()->fireAction($this, 'initFilePermissionValidator');
	}

}

Display More

Vielen Dank & viele Grüße
Dominik

dominik4545 · February 13, 2016 at 7:44 PM

Guten Abend zusammen,

hat jemand von Euch eine Idee? Würde gerne über's Wochenende weitermachen

Vielen Dank & schönes Wochenende
Dominik

dominik4545 · February 16, 2016 at 10:20 AM

Ich stehe noch immer vor einem Rätsel

Folgende Ausgabe ergibt print_r zum Zeitpunkt von getMessage() der Klasse oben:

PHP

Display More

Ein print_r zum Zeitpunkt von getEmailMessage() aus derselben Klasse ergibt jedoch folgendes:

PHP

Display More

Wisst ihr, wo meine Autoren und meine Notification hin ist? Vor allem die Information timesTriggered der Notification wäre essentiell, da eine Auswertung der Anzahl von Autoren irrelevant ist. Schließlich kann ein Autor 25 Dateien hochladen, dabei sollen dem Benutzer dann aber auch angezeigt werden, dass 25 neue Dateien und nicht 1 neue Datei hochgeladen wurde.

Vielen Dank im Voraus für Eure Hilfe!

Viele Grüße
Dominik

Benutzerbenachrichtigungen

Participate now!

Similar Threads

Benutzerbenachrichtigungen einzelner Benutzer als Admin ändern