Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_copyposting_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:fo_copyposting_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== fo_CopyPosting_Pu =====
 +
 +Kopiert einen Forum-Beitrag - inklusive aller Antworten des Beitrags (sofern gewünscht).\\ Im folgenden sprechen wir daher der Einfachheit halber von "zu kopierenden Beiträgen"​.\\ ​
 +
 +Hinweise :\\ 
 +
 +1. Selbstverständlich werden immer die Rechte, die die durch "​PersonIdentificationValues",​ "​PersonTypeID"​ und "​UniqueID"​ identifizierte Person hat, für das Forum der zu kopierenden Beiträge sowie für das Forum, in das die Beiträge kopiert werden sollen, überprüft. Falls die Identifizierung fehlschlägt,​ werden die Rechte für die anonyme Person (mit der speziellen "​PersonID = 0") gecheckt.\\ ​
 +
 +Es werden folgende Rechte benötigt :\\ 
 +
 + (i) Im "​Quellforum"​ genügt lesender Zugriff, sofern die zu kopierenden Beiträge im Status "​4"​ oder "​8"​ sind.\\ Gibt es jedoch einen Beitrag, der "​unbestätigt"​ ist ("​Visible = 1"), muß die identifizierte Person das Recht zum Bestätigen von Postings ("​AccessLevelID = 64") besitzen - sonst gibt es den Fehler "​-802"​. Alternativ kann man solche Beiträge auch auslassen (um den Fehler zu vermeiden), indem man für "​IncludeReplies"​ den Wert "​2"​ angibt. Ist allerdings schon der durch "​PostingID"​ angegeben Beitrag selbst "​unbestätigt"​ und besitzt die identifizierte Person nicht das entsprechende Recht, ist ein Fehler in jedem Fall unvermeidbar.\\ ​
 +
 +(ii) Im "​Zielforum"​ (also entweder in "​TargetForumID"​ oder im Forum von "​TargetPostingID"​) wird je nach "​KeepAuthor"​ und je nachdem ob ein "​MainPosting"​ oder eine oder mehrere Antwort(en) entsteht/​entstehen,​ eines der folgenden Rechte benötigt :
 +  * "​anlegen eines Beitrags unter anderem Autor" ("​AccessLevelID = 8192")
 +  * "​eröffnen eines neuen Threads"​ ("​AccessLevelID = 4")
 +  * "​antworten auf bestehendes Posting"​ ("​AccessLevelID = 2")
 +
 +
 +2. In der Kopie sind sowohl "​Binaries"​ als auch "​PostingProperties"​ eingeschlossen - bei letzteren allerdings nur solche zur\\ "​PersonID = 0" ! Ist anderes gewünscht, kann man "​IncludeBinaries"​ bzw. "​IncludeProperties"​ auf "​0"​ setzen. Natürlich kann es vorkommen, daß für das Zielforum (in dem die Kopie erstellt werden soll) andere Beschränkungen hinsichtlich "​Binaries"​ konfiguriert sind (Anzahl "​Binaries",​ Maximale Größe eines Binaries, etc.). Verletzt ein "​Binary",​ das zu kopieren ist, diese Beschränkung,​ gibt es einen entsprechenden Fehler. Möchte man solche "​Binaries"​ hingegen einfach auslassen, setzt man "​IncludeBinaries"​ auf "​2"​.\\ Analog kann es sein, daß bestimmte Merkmale für "​PostingProperties"​ im Zielforum nicht erlaubt sind - dann gibt es ebenfalls einen Fehler. Um solche Eigenschaften auszulassen (und damit einen Fehler zu vermeiden), setzt man "​IncludeProperties"​ auf "​2"​.\\ ​
 +
 +3. Ist "​PostingID"​ bereits im Visible-Status "​gelöscht",​ kann der Beitrag NICHT mehr kopiert werden ! ( => "​-803"​)\\ ​
 +
 +4. Antworten, die "​gelöscht"​ sind ("​Visible = 0") werden grundsätzlich NICHT KOPIERT !\\ 
 +|HTTP-Method|POST |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[fo Copy Posting Pu]}}|
 +|Engine-Kategorie|forums |
 +|Engine-Typ|Daten-Änderung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-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 ^
 +|__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)|5.1.0|
 +|__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|5.1.0|
 +|__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)|5.1.0|
 +|__PostingID__| |ID eines Beitrags, der kopiert werden soll\\ |integer|5.1.0|
 +|__TargetForumID__| |ID eines Forums, in das "​PostingID"​ kopiert werden soll. Falls angegeben, wird die Kopie von "​PostingID"​ in diesem Forum zum Hauptbeitrag.\\ |smallint|5.1.0|
 +|TargetPostingID|NULL |Wird nur beachtet, wenn "​TargetForumID"​ nicht angegeben (also "​NULL"​) ist ! ID eines Beitrags, unter das (als direkte Antwort) "​PostingID"​ kopiert werden soll.\\ |integer|5.1.0|
 +|KeepAuthor|0 |"​1"​ : Der Autor des jeweils zu kopierenden Beitrags ist auch der Autor der Kopie (ACHTUNG : es wird ein entsprechendes Recht benötigt, s. Beschreibung !)\\ "​0"​ : Die identifizierte Person wird Autor der Kopien\\ |bit|5.1.0|
 +|IncludeReplies|1 |Gibt an, ob auch die Antworten von "​PostingID"​ mitkopiert werden sollen ("​1"​ oder "​2"​) oder nicht ("​0"​). "​2"​ angeben, um unbestätigte Beiträge ("​Visible = 1") NICHT zu kopieren (weil z.B. das entsprechende Recht fehlt, s. Beschreibung).\\ |tinyint|5.1.0|
 +|IncludeBinaries|1 |Gibt an, ob auch alle "​Binaries"​ der zu kopierenden Beiträge mitkopiert werden sollen ("​1"​ o. "​2"​) oder nicht ("​0"​). "​2"​ angeben, um "​Binaries"​ auszulassen,​ die gegen bestimmte Konfigurationen im Zielforum verstoßen (s. Beschreibung).\\ |tinyint|5.1.0|
 +|IncludeProperties|1 |Gibt an, ob alle "​Properties"​ (zur "​PersonID = 0") der zu kopierenden Beiträge mitkopiert werden sollen ("​1"​ o. "​2"​) oder nicht ("​0"​). "​2"​ angeben, um "​Properties"​ auszulassen,​ die gegen bestimmte Konfigurationen im Zielforum verstoßen (s. Beschreibung).\\ |tinyint|5.1.0|
 +|Author|NULL |Name des Autors der Kopien. Wird ignoriert, falls "​KeepAutor = 1" ist oder wenn die identifizierte Person NICHT anonym ist UND in "​ForumSettings"​ ein Eintrag zum Schlüssel "​CharacteristicIDsForAuthor_<​PersonTypeID der identifizierten Person>"​ existiert !\\ |varchar(100)|5.1.0|
 +|EMailOfAuthor|NULL |Wird nur beachtet, wenn "​KeepAuthor = 0" ist ! Gibt die "​eMail"​-Adresse des Autors der Kopien an.\\ |varchar(100)|5.1.0|
 +|SeparatorInIdentVals|'​¶'​ |Gibt an, durch welche Zeichen die Werte in "​PersonIdentificationValues"​ getrennt sind\\ |varchar(4)|5.5.0|
 +==== Rückgabe ====
 +
 +Die Prozedur hat keine Rückgaben.
 +==== 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"​)) ^
 +|-874|Die Posting-Eigenschaften können nicht gesetzt/​geändert/​gelöscht werden, da Fehler auftraten|nur direkt|
 +|-856|Fehlerhafte Daten in "​MainPostingSorting"​|nur indirekt|
 +|-855|Fehlerhafte Konfiguration des Sortier-Kriteriums|nur indirekt|
 +|-850|Sortier-Kriterium nicht definiert oder inaktiv oder nicht verwendbar|nur indirekt|
 +|-815|Keine Berechtigung zum Anlegen eines Beitrags unter anderem Autor|nur direkt|
 +|-813|Keine Berechtigung zum Antworten auf ein bestehendes Posting|nur direkt|
 +|-812|Keine Berechtigung zur Eröffnung eines neuen Threads|nur direkt|
 +|-807|Es sind zu viele Binaries zu dem Posting vorhanden|nur direkt|
 +|-806|Filesize ist zu groß|nur direkt|
 +|-803|Das Posting ist gelöscht|nur direkt|
 +|-802|Keine Berechtigung zum Bestätigen von Postings des Forums|nur direkt|
 +|-801|Kein lesender Zugriff auf das Forum|nur direkt|
 +|-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|
 +|-572|Die Prozedur darf nur innerhalb einer Transaktion ausgeführt werden|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 ====
 +
 +|7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard,​ u.a. wg. UTF8-Unterstützung\\ ​ |
 +|5.5.1 |2008-07-29|1. Berücksichtigung des neuen "​Settings"​-Eintrags "​AssignmentMethodForListVariables"​\\ 2. Auslagerung der Ermittlung, zu welchen Merkmalen "​Properties"​ hinterlegt werden dürfen [Foren-abhängig] in eine eigene [neue] Prozedur ["​_fo_GetCharacsForForum"​]\\ ​ |
 +|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\\ ​ |
 +|5.1.6 |2006-09-14|Die Tabelle "​PostingBinaries"​ hat zwei neue Spalten bekommen => entsprechende Änderungen\\ ​ |
 +|5.1.2 |2006-06-26|Interne Änderung, damit die Prozedur auch für ASE 15.x funktioniert\\ ​ |
 +|5.1.0 |2006-02-08|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_CopyPosting_Pu|fo_CopyPosting_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_CopyPosting_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​PostingID=<​value>&​TargetForumID=<​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_CopyPosting_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​PostingID=<​value>&​TargetForumID=<​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_CopyPosting_Pu',​
 + array(
 + '​PersonIdentificationValues'​ => '<​value>',​
 + '​PersonTypeID'​ => <​value>,​
 + '​UniqueID'​ => '<​value>',​
 + '​PostingID'​ => <​value>,​
 + '​TargetForumID'​ => <​value>,​
 + // '​TargetPostingID'​ => NULL,
 + // '​KeepAuthor'​ => 0,
 + // '​IncludeReplies'​ => 1,
 + // '​IncludeBinaries'​ => 1,
 + // '​IncludeProperties'​ => 1,
 + // '​Author'​ => NULL,
 + // '​EMailOfAuthor'​ => NULL,
 + // '​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_CopyPosting_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​PersonIdentificationValues"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​PersonTypeID"><​!-- tinyint value --></​Parameter>​
 + <​Parameter Name="​UniqueID"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​PostingID"><​!-- integer value --></​Parameter>​
 + <​Parameter Name="​TargetForumID"><​!-- smallint value --></​Parameter>​
 + <!-- <​Parameter Name="​TargetPostingID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​KeepAuthor">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeReplies">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeBinaries">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeProperties">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​Author">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​EMailOfAuthor">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​SeparatorInIdentVals">'​¶'</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/fo_copyposting_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)