engine:procedures:co_getmd5forbinaryid_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:co_getmd5forbinaryid_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== co_GetMD5ForBinaryID_Pu ===== | ||
| + | |||
| + | Gibt zur ID eines Community-Binärobjektes den "MD5-Hash" zurück - sofern das identifizierte Mitglied das Recht besitzt, das "Binary" des angegebenen Mitglieds einzusehen.\\ | ||
| + | |||
| + | Der MD5-Hash wird dann benötigt, wenn ein Community-Mitglied z.B. ein Bild, das einem anderen Mitglied gehört, speichern möchte. Das kann man nur durch die Prozedur [[dstoreproc>co_InsertNewMemberBinary_Pu]] bewerkstelligen, die aber als eindeutiges Kennzeichen eines "Binaries" den MD5-Hash der Datei verwendet.\\ | ||
| + | |||
| + | Weiterer Hintergrund : Die Binärobjekte sind nicht in der Datenbank gespeichert, sondern in einem externen Bereich (andere Datenbank, Filesystem etc.). Man benötigt nun zum Anzeigen eines Binärobjektes eine öffentliche Funktion (in der Sprache des jeweiligen Frontends), die einen Identifier für das Binärobjekt bekommt und dann die Datei zurückliefert. Handelt es sich bei dem Identifier nur um eine Zahl-ID (wie die "BinaryID"), könnte ein Community-Mitglied leicht durch Ausprobieren an alle gespeicherten "Binaries" kommen - obwohl es für manche kein Leserecht besitzt. Ein MD5-Hash macht das jedoch unmöglich. (Die Zugriffsrechte werden derzeit über die Kategorien von Binärobjekten gesteuert, siehe [[dstoreproc>co_GetBinaryCategories_Ad]] und [[dstoreproc>co_GetBinaryCatAccessLevels]].)\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[co Get For Binary Pu]}}| | ||
| + | |Engine-Kategorie|communities | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|6.5.4 (2013-04-29)| | ||
| + | |||
| + | ==== 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 ^ | ||
| + | |__UniqueID__| |Eindeutige ID eines Besuchers, die dem zu identifizierenden Mitglied aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in "SessionManagement" (zu dieser "UniqueID") gespeichert sind, darf "PersonIdentificationValues" auch "NULL" sein.\\ |varchar(50)|3.5.2| | ||
| + | |__PersonIdentificationValues__| |Liste von Werten, die das Mitglied identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in "PersonTypeSettings" zur "PersonTypeID" der "CommunityID" zum Schlüssel "PersonIdentificationIDs" hinterlegt sind.\\ |varchar(255)|3.5.2| | ||
| + | |__CommunityID__| |ID einer Community\\ |smallint|3.5.2| | ||
| + | |__CommunityMemberID__| |ID eines Mitglieds der Community, dem das Binärobjekt "BinaryID" gehört. Wird hier "NULL" übergeben, nimmt die Prozedur das identifizierte Mitglied als "Besitzer" des "Binaries" an.\\ |integer|3.5.2| | ||
| + | |__BinaryID__| |ID eines "Binaries", das dem Mitglied "CommunityMemberID" gehört und zu dem der "MD5-Hash" ermittelt werden soll.\\ |integer|3.5.2| | ||
| + | |AdditionalBinaryInformation|0 |Sollen neben dem "MD5-Hash" zusätzliche Informationen zum Binärobjekt "BinaryID" ausgegeben werden ?\\ |bit|3.5.7| | ||
| + | |SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichenkette die Werte in "PersonIdentificationValues" getrennt sind\\ |varchar(4)|5.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === wenn AdditionalBinaryInformation = 0 === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |MD5Hash|Der "MD5-Hash" der durch "BinaryID" angegebenen Datei\\ |varchar(50)|3.5.2 | | ||
| + | === wenn AdditionalBinaryInformation = 1 === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |MD5Hash|Der "MD5-Hash" der durch "BinaryID" angegebenen Datei\\ |varchar(50)|3.5.2 | | ||
| + | |ContentType|Das Format der Datei (z.B. "gif" oder "jpg")\\ |varchar(100)|3.5.7 | | ||
| + | |FilesizeInKB|Größe der Datei in KiloBytes\\ |integer|3.5.7 | | ||
| + | |FileDateAndTime|Erstellungsdatum der Datei\\ |datetime|3.5.7 | | ||
| + | ==== 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")) ^ | ||
| + | |-781|Fehlender oder falscher Eintrag in CommunitySettings|nur indirekt| | ||
| + | |-780|Fehlender oder falscher Eintrag in CommunityMemberSettings|nur indirekt| | ||
| + | |-774|Login vorübergehend gesperrt|nur indirekt| | ||
| + | |-773|Login gesperrt|nur indirekt| | ||
| + | |-772|User ist nicht angemeldet|nur indirekt| | ||
| + | |-771|Der Sweeper ist nicht gestartet|nur indirekt| | ||
| + | |-770|Login zur Zeit nicht möglich|nur indirekt| | ||
| + | |-733|Keine Berechtigung zum Auslesen von Binärdateien in dieser Kategorie|nur indirekt| | ||
| + | |-732|Keine Berechtigung zum Einfügen von Binärdateien in dieser Kategorie|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.4 |2013-04-29|Datentyp des Parameters "SeparatorInIdentVals" wg. UTF-8 Unterstützung auf "varchar[4]" erweitert\\ | | ||
| + | |5.5.0 |2008-01-07|1. Neuer Parameter "SeparatorInIdentVals"\\ 2. Ausgabe via "print" im Fehler-Fall "-500", die nähere Informationen über die Ursache enthält\\ 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\ | | ||
| + | |3.5.7 |2001-05-04|\\ | | ||
| + | |3.5.2 |2001-01-28|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=co_GetMD5ForBinaryID_Pu|co_GetMD5ForBinaryID_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMD5ForBinaryID_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>&CommunityMemberID=<value>&BinaryID=<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 GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMD5ForBinaryID_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>&CommunityMemberID=<value>&BinaryID=<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'), | ||
| + | 'co_GetMD5ForBinaryID_Pu', | ||
| + | array( | ||
| + | 'UniqueID' => '<value>', | ||
| + | 'PersonIdentificationValues' => '<value>', | ||
| + | 'CommunityID' => <value>, | ||
| + | 'CommunityMemberID' => <value>, | ||
| + | 'BinaryID' => <value>, | ||
| + | // 'AdditionalBinaryInformation' => 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="co_GetMD5ForBinaryID_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="UniqueID"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="CommunityID"><!-- smallint value --></Parameter> | ||
| + | <Parameter Name="CommunityMemberID"><!-- integer value --></Parameter> | ||
| + | <Parameter Name="BinaryID"><!-- integer value --></Parameter> | ||
| + | <!-- <Parameter Name="AdditionalBinaryInformation">0</Parameter> --> | ||
| + | <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/co_getmd5forbinaryid_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)