Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getmd5forbinaryid_pu

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 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 co_GetBinaryCategories_Ad und co_GetBinaryCatAccessLevels.)

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriecommunities
Engine-TypDaten-Ermittlung
Letzte Aktualisierung6.5.4 (2013-04-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) 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
smallint3.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.
integer3.5.2
BinaryID ID eines „Binaries“, das dem Mitglied „CommunityMemberID“ gehört und zu dem der „MD5-Hash“ ermittelt werden soll.
integer3.5.2
AdditionalBinaryInformation0 Sollen neben dem „MD5-Hash“ zusätzliche Informationen zum Binärobjekt „BinaryID“ ausgegeben werden ?
bit3.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-Datentyp4) ab Version
MD5HashDer „MD5-Hash“ der durch „BinaryID“ angegebenen Datei
varchar(50)3.5.2

wenn AdditionalBinaryInformation = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
MD5HashDer „MD5-Hash“ der durch „BinaryID“ angegebenen Datei
varchar(50)3.5.2
ContentTypeDas Format der Datei (z.B. „gif“ oder „jpg“)
varchar(100)3.5.7
FilesizeInKBGröße der Datei in KiloBytes
integer3.5.7
FileDateAndTimeErstellungsdatum der Datei
datetime3.5.7

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-781Fehlender oder falscher Eintrag in CommunitySettingsnur indirekt
-780Fehlender oder falscher Eintrag in CommunityMemberSettingsnur indirekt
-774Login vorübergehend gesperrtnur indirekt
-773Login gesperrtnur indirekt
-772User ist nicht angemeldetnur indirekt
-771Der Sweeper ist nicht gestartetnur indirekt
-770Login zur Zeit nicht möglichnur indirekt
-733Keine Berechtigung zum Auslesen von Binärdateien in dieser Kategorienur indirekt
-732Keine Berechtigung zum Einfügen von Binärdateien in dieser Kategorienur indirekt
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-602Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werdennur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

6.5.4 2013-04-29Datentyp des Parameters „SeparatorInIdentVals“ wg. UTF-8 Unterstützung auf „varchar[4]“ erweitert
5.5.0 2008-01-071. 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-28Erstmalig 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:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetMD5ForBinaryID_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>&CommunityMemberID=<value>&BinaryID=<value>'

Mit xmllint 7) formatierte Ausgabe:

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 -
dStore_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();
engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?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>
1)
Pflichtparameter sind unterstrichen
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_getmd5forbinaryid_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)