Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_checkforumaccess_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:fo_checkforumaccess_pu [11.01.2016 ]
engine:procedures:fo_checkforumaccess_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== fo_CheckForumAccess_Pu =====
 +
 +Überprüft bestimmte Zugriffsrechte einer Person für ein oder mehrere Foren. Von den zu überprüfenden Foren werden die, für die die identifizierte Person über die angegebenen Zugriffsrechte (-> "​AccessLevel"​) verfügt, zurückgegeben.\\ ​
 +
 +Schlägt die Identifikation fehl, werden die Zugriffsrechte der anonymen Person ("​PersonID = 0") ermittelt.\\ ​
 +
 +Hinweis zum grundsätzlichen Verfahren bzgl. Zugriffsrechte in Foren:\\ Unabhängig von der Aktion, die ein Teilnehmer eines Forums vornehmen möchte (Beitrag erstellen, Beitrag löschen, Thread abschließen,​ ein Binärobjekt zu einem Posting hinzufügen etc.), wird zunächst überprüft,​ ob er über das entsprechende Zugriffsrecht verfügt. Dabei gilt : Direkt für eine Person zugewiesene Rechte haben Vorrang vor Gruppenrechten. Hat jemand keine direkt definierten Zugriffsrechte,​ besitzt er die Rechte, die ALLE Gruppen, denen er zugeordnet ist, ZUSAMMEN für das entsprechende Forum bekommen haben. Sind weder für die identifizierte Person, noch für irgendeine Gruppe, zu der die Person gehört, Zugriffsrechte vergeben, werden die Rechte des anonymen Benutzers ("​PersonID = 0") herangezogen - sind auch hierzu keine Rechte eingetragen,​ hat die Person überhaupt keinen Zugriff auf das Forum.\\ ​
 +|HTTP-Method|POST |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[fo Check Forum Access Pu]}}|
 +|Engine-Kategorie|forums |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|6.5.3 (2013-03-18)|
 +
 +==== Parameter ====
 +
 +^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:​engine_parameterconventions|Parameter-Konventionen engine/<​Prozedur-Name>​]])) ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|__PersonIdentificationValues__| |Liste von Werten, die den Forum-Teilnehmer identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in "​PersonTypeSettings"​ zur "​PersonTypeID"​ zum Schlüssel "​PersonIdentificationIDs"​ hinterlegt sind.\\ |varchar(255)|3.5.15|
 +|__PersonTypeID__| |ID des Personen-Typs dem der zu identifizierende Forum-Teilnehmer angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.\\ |tinyint|3.5.15|
 +|__UniqueID__| |Eindeutige ID eines Besuchers, die dem zu identifizierenden Forum-Teilnehmer aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in "​SessionManagement"​ (zur "​UniqueID"​) gespeichert sind, darf "​PersonIdentificationValues"​ "​NULL"​ sein.\\ |varchar(50)|3.5.15|
 +|__AccessLevel__| |Gibt an, welche Rechte überprüft werden sollen. Enthält eine Summe von "​AccessLevelID"​s (siehe [[dstoreproc>​fo_GetForumAccessLevels]]).\\ |smallint|3.5.15|
 +|ForumID|NULL |ID des Forums zu dem der Zugriff für den identifizierten Teilnehmer ermittelt werden soll. "​NULL"​ bedeutet, daß entweder ALLE Foren überprüft werden oder nur die in "​tempdb.dbo.OneID"​ angegebenen (je nach "​CheckForumIDsInOneID"​)\\ |smallint|3.5.15|
 +|CheckForumIDsInOneID|0 |Um Zugriffsrechte für mehrere Foren zu überprüfen,​ übergibt man für "​ForumID"​ "​NULL",​ setzt diesen Parameter auf "​1"​ und fügt die gewünschten "​ForumID"​s in "​tempdb.dbo.OneID"​. Zur Überprüfung ALLER Foren ist hier "​0"​ und für "​ForumID"​ "​NULL"​ anzugeben.\\ |bit|3.5.15|
 +|SeparatorInIdentVals|'​¶'​ |Gibt an, durch welche Zeichenkette die Werte in "​PersonIdentificationValues"​ getrennt sind\\ |varchar(4)|5.5.0|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|ForumID|ID eines zu überprüfenden Forums (z.B. "​ForumID"​ oder eine ID, die in "​tempdb.dbo.OneID"​ übergeben wurde)\\ |smallint|3.5.15 |
 +|ForumName|Name des Forums "​ForumID"​\\ |varchar(100)|3.5.15 |
 +|Language|Sprache des Forums "​ForumID"​ - d.h. die Beiträge des Forums sind in dieser Sprache (bzw. sollten es sein)\\ |varchar(50)|3.5.15 |
 +==== Output-Parameter ====
 +
 +Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-800|Kein Zugriff auf das Forum|nur indirekt|
 +|-660|Identifikation fehlgeschlagen|nur indirekt|
 +|-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt|
 +|-602|Zur defaultUniqueID ("​VisitorID = -2") können keinerlei Daten gespeichert oder verändert werden|nur indirekt|
 +|-599|Lizenz ist ungültig oder abgelaufen|nur indirekt|
 +|-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt|
 +|-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt|
 +|-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt|
 +|-550|Fehlender oder falscher Eintrag in Settings|nur indirekt|
 +|-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt|
 +|-530|Der Wert ist nicht konvertierbar|nur indirekt|
 +|-510|Der Benutzer ist nicht registriert|nur indirekt|
 +|-504|Es ist ein Problem aufgetreten,​ das nicht gelöst werden kann, Prozedur wird daher abgebrochen|nur indirekt|
 +|-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt|
 +|-500|Falsche Parameter|direkt und indirekt|
 +==== XML-Schema ====
 +
 +Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://​resources.dstore.de/​xsd/​webservice_SmartGate/​Response/​EngineProcedure_v1_0.xsd|Response/​EngineProcedure_v1_0.xsd]] validiert.
 +==== Historie ====
 +
 +|6.5.3 |2013-03-18|Datentyp von "​SeparatorInIdentVals"​ wg. UTF8-Unterstützung angepasst\\ ​ |
 +|6.5.0 |2012-09-17|Holger Wies : Datentyp des Parameters "​PersonTypeID"​ von "​smallint"​ auf "​tinyint"​ korrigiert\\ ​ |
 +|5.5.0 |2008-01-07|1. Neuer Parameter "​SeparatorInIdentVals"​\\ 2. Ausgabe an die Standard-Ausgabe [via "​print"​] im Fehler-Fall "​-500",​ die nähere Informationen über die Ursache enthält\\ 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\ ​ |
 +|4.0.4 |2003-08-26|1. Fehler (bzgl. eines "​Joins"​ zu "​Forums"​) behoben\\ 2. Eine intern verwendete Prozedur wurde um Parameter erweitert, die die Performance verbessern => entsprechende Anpassung\\ ​ |
 +|4.0.1 |2003-05-16|1. Wenn die Identifizierung fehlschlägt,​ muß die anonyme Person angenommen werden !\\ 2. Wenn eine "​ForumID"​ übergeben wurde und NICHT alle Rechte (-> "​AccessLevel"​) vorhanden waren, gab es KEINE Ergebnismenge,​ es muß aber eine leere Ergebnismenge sein !\\  |
 +|3.5.15 |2002-03-12|Erstmalig in dieser Version erstellt\\ ​ |
 +
 +==== Code-Snippets ====
 +
 +== Engine Playground ==
 +Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
 +  * [[http://​playground.dstore.de/​index.php?​proc=fo_CheckForumAccess_Pu|fo_CheckForumAccess_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_CheckForumAccess_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​AccessLevel=<​value>'</​code>​Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert,​ Bestandteil der libxml2, siehe http://​www.xmlsoft.org)) formatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_CheckForumAccess_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​AccessLevel=<​value>'​ | xmllint --format -</​code>​== dStore_php ==
 +<code php>
 +use dStore_php\WebService;​
 +
 +$service = new WebService\Service( WebService\Scheme::​HTTP,'<​partner>​-<​project>​.dstore.de',​ 80);
 +
 +$request = new WebService\Requests\Engine\Procedure\Request(
 + new WebService\Requests\AccessData('​default'​),​
 + '​fo_CheckForumAccess_Pu',​
 + array(
 + '​PersonIdentificationValues'​ => '<​value>',​
 + '​PersonTypeID'​ => <​value>,​
 + '​UniqueID'​ => '<​value>',​
 + '​AccessLevel'​ => <​value>,​
 + // '​ForumID'​ => NULL,
 + // '​CheckForumIDsInOneID'​ => 0,
 + // '​SeparatorInIdentVals'​ => '​¶'​
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +</​code>​
 +== engine/​execute ==
 +XML zur Ausführung mit der Methode [[:​webservice:​engine:​execute|engine/​execute]],​ z.B. per
 +  curl --header '​Content-Type:​ application/​xml'​ -X POST '​http://<​partner>​-<​kunde>​.dstore.de/​default/​engine/​execute'​ -d '<​xml-daten>'​
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​ListOfBatches>​
 + <Batch No="​0">​
 + <​Procedure Name="​fo_CheckForumAccess_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​PersonIdentificationValues"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​PersonTypeID"><​!-- tinyint value --></​Parameter>​
 + <​Parameter Name="​UniqueID"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​AccessLevel"><​!-- smallint value --></​Parameter>​
 + <!-- <​Parameter Name="​ForumID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​CheckForumIDsInOneID">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​SeparatorInIdentVals">'​¶'</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/fo_checkforumaccess_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)