OPML-Exporte #

Lesen Sie diese Seite, wenn Sie RSS-Feeds aus Exponential veröffentlichen oder die Templates zum Bearbeiten und Auflisten von RSS überschreiben. Ein RSS-Export kann jetzt als OPML-2.0-Dokument geschrieben werden: eine Liste anderer Feeds, das Format, das Feedreader importieren, wenn jemand seine Abonnements veröffentlicht. Das Upgrade braucht ein Datenbank-Update; vorhandene Exporte ändern sich nicht.

Kurz gesagt #

Upgrade #

Die neue Tabelle und die neue Spalte stehen im Update-Skript jeder Datenbank-Engine:

update/database/mysql/6.0/dbupdate-6.0.0-6.0.15.sql
update/database/postgresql/6.0/dbupdate-6.0.0-6.0.15.sql
update/database/sqlite/6.0/dbupdate-6.0.0-6.0.15.sql

Eine Neuinstallation erhält sie aus kernel/sql/* und share/db_schema.dba. Sonst ist nichts nötig: rss_version speichert weiterhin 1.0, 2.0 und ATOM, und OPML ist ein vierter Wert daneben.

Was ein OPML-Export ist #

Ein RSS-Export war schon immer ein Feed von Artikeln, die aus Inhalten gesammelt werden. Ein auf OPML gesetzter Export hat keine Inhaltsquelle und keine Zuordnung von Klassen. Er hat stattdessen Outlines, von denen jede einen anderen Export dieser Installation, einen Inhaltsknoten oder eine einfache Adresse nennt. Die Adresse jeder Outline wird beim Schreiben des Dokuments ermittelt, sodass das Umbenennen eines Feeds keinen toten Eintrag hinterlassen kann.

Einen Export in ein OPML-Dokument verwandeln #

/rss/edit_export/<id> → Feed-Format → OPML 2.0 (list of feeds).

Die Seite zeigt dann die Bedienelemente für OPML anstelle der Inhaltsquellen. Die Auswahlliste des Formats wurde in diesem Release neu beschriftet: Sie heißt Feed-Format statt RSS Version, und jede Option sagt, welches Format sie ist — RSS 1.0 (RDF), RSS 2.0, Atom 1.0, OPML 2.0 (list of feeds). Der Wert hinter jeder Option ist unverändert, sodass alles, was rss_version liest oder schreibt, weiter funktioniert.

Der Feed wird unter /rss/feed/<access url> als text/x-opml ausgeliefert.

Datenbank #

ezrss_export_opml_item (neu) #

Eine Zeile pro Outline. Entwurfs- und gültige Zeilen stehen unter status nebeneinander, genau wie bei ezrss_export_item, sodass das Bearbeiten eines OPML-Exports so umkehrbar ist wie das Bearbeiten jedes anderen.

Primärschlüssel (id, status), Index ezrss_export_opml_rsseid (rssexport_id).

outline_text statt text, weil text in mehr als einem Dialekt ein Typname ist.

ezrss_export.opml_head (neue Spalte) #

longtext (text unter PostgreSQL). Die Kopffelder von OPML als JSON. Eine Spalte statt eines Dutzends: Sie werden einmal geschrieben, einmal gelesen, nie durchsucht, und eine Installation ohne OPML-Export füllt sie nie aus.

Schlüssel: ownerName, ownerEmail, ownerId, docs, expansionState, vertScrollState, windowTop, windowLeft, windowBottom, windowRight.

PHP-API #

eZRSSExportOPMLItem — kernel/classes/ezrssexportopmlitem.php #

Ein eZPersistentObject über ezrss_export_opml_item.

Konstanten

Zeilen

• create( $exportId, $targetExportId = 0, $priority = 0 ) — eine neue Zeile, Status Entwurf.
• fetch( $id, $asObject = true, $status = STATUS_VALID )
• fetchList( $exportId, $status = STATUS_VALID ) — in der Reihenfolge des Dokuments.
• fetchListCount( $exportId, $status = STATUS_VALID )
• fetchTree( $exportId, $status = STATUS_VALID, $limit = false ) — die Zeilen so angeordnet, wie OPML sie verschachtelt: array( array( 'item' => …, 'children' => array( … ) ) ). Ein verschwundener Elternknoten lässt seine Kinder auf der obersten Ebene, statt sie fallen zu lassen; zwei Zeilen, die ineinander stehen, werden nirgends geschrieben statt endlos.
• selectedTargetIDs( $exportId, $status = STATUS_VALID ) — bereits aufgeführte Export-IDs, mit sich selbst als Schlüssel.
• nextPriority( $exportId, $status = STATUS_DRAFT )
• addTargets( $exportId, array $targetIDs, $status = STATUS_DRAFT ) — gibt zurück, wie viele hinzugefügt wurden. Überspringt, was nicht existiert, was bereits aufgeführt ist, und den Export selbst; hält bei MAX_BULK an; prüft alles in einer Abfrage.
• removeItems( $exportId, array $itemIDs ) — auf dieselbe Weise begrenzt.
• removeByExport( $exportId, $status = false ) — false bedeutet jeden Status.
• copyStatus( $exportId, $fromStatus, $toStatus ) — verwendet, wenn ein Export zum Bearbeiten geöffnet und wenn er veröffentlicht wird.

Eine Zeile lesen

• targetExport() / Attribut target — der aufgeführte Export oder null.
• targetGone() / Attribut target_gone — er wurde inzwischen gelöscht.
• sourceNode() / Attribut source_node
• sourcePath() / Attribut source_path
• outline( $baseURL = '' ) / Attribut outline — die Zeile, wie OPML sie ausdrückt, oder null, wenn es nichts Schreibenswertes gibt. Überschreibungen gewinnen; was leer bleibt, kommt vom Ziel.

Werte

• safeText( $value, $max = MAX_TEXT ) — entfernt Steuerzeichen, die XML nicht tragen kann, trimmt, kürzt auf $max Zeichen, ohne eines zu zerteilen. Alles, was keine Zeichenkette ist oder kein gültiges UTF-8, kommt leer zurück.
• safeURL( $value, $max = MAX_TEXT ) — safeText, dann überleben nur ALLOWED_SCHEMES, protokollrelative und seitenrelative Adressen.
• siteOf( $url ) — der Teil der Website, mit einem eventuellen /rss/feed/… wieder entfernt.
• absolute( $baseURL, $path )
• outlineTypes() — Typ ⇒ das Wort dafür in der Oberfläche.
• opmlVersionOf( $rssVersion ) — 1.0 ⇒ RSS1, 2.0 ⇒ RSS2, ATOM ⇒ ATOM.

eZRSSExport — Ergänzungen #

• isOPML() / Attribut is_opml
• opmlItemList() / Attribut opml_item_list
• opmlHead() / Attribut opml_head_data — die Kopffelder als Hash, mit Standardwerten. Eine Spalte voller Unsinn wird gelesen, als sei nichts ausgefüllt.
• setOPMLHead( array $head ) — behält nur die Schlüssel, die OPML definiert, und nur Werte, die zu ihnen passen: docs muss eine Adresse sein, ownerEmail eine E-Mail-Adresse, die Fenster- und Scrollfelder Zahlen oder Listen von Zahlen.
• generateOPML() — das Dokument, mit DOM gebaut.
• emptyOPML( $title = '' ) — ein gültiges Dokument als Rückfall.
• opmlDate( $timestamp ) — RFC 822, wie OPML es verlangt.
• opmlMaxOutlines() — [RSSSettings] OPMLMaxOutlines, Standard 5000, nie über 50000.
• formatLabels() / formatLabel( $version ) — die Wörter für einen gespeicherten Formatwert. Ein Wert, für den niemand einen Namen hat, wird so angezeigt, wie er steht.
• fetchList( $asObject = true, $offset = false, $limit = false, $sorts = null ) — nimmt jetzt einen Ausschnitt und eine Reihenfolge an; ohne Argumente gibt es weiterhin alles zurück.
• fetchListCount()
• sortableFields() — die einzigen Spalten, die eine Sortierklausel erreichen dürfen.
• fetchBrowserList( $search, $offset, $limit, $sorts, $excludeID ) / fetchBrowserListCount( $search, $excludeID ) — die Seite des Feed-Browsers. $search sucht in Name, Adresse und Beschreibung, wobei seine eigenen Platzhalter entschärft werden.

eZRSSListPager — kernel/rss/ezrsslistpager.php #

Gemeinsam genutzt von /rss/list und vom Browser innerhalb der Bearbeitungsseite.

• limits() — array( 25, 50, 250 )
• limit( $requested, $remembered = false )
• offset( $offset, $limit, $count )
• data( $count, $limit, $offset, $offsetName, $suffix, $window = 9 )
• sort( $field, $direction, array $allowed, $default ) — fügt immer id als Entscheidung bei Gleichstand hinzu, sofern nicht bereits nach id sortiert wird.
• suffix( array $parameters ) / suffixExcept( array $state, array $names )

eZRSSImport — Ergänzungen #

• fetchableURL( $url ) — die zu holende Adresse oder false.
• isFetchableURL( $url ) — dasselbe als Boolescher Wert.

Einstellungen #

Die ausgelieferten Zeilen:

AvailableVersionList[]=OPML

# The most outlines one OPML document will carry. Bounded at 50000 whatever
# this says.
OPMLMaxOutlines=5000

NumberOfObjectsList[]=100
NumberOfObjectsList[]=250
NumberOfObjectsList[]=350
NumberOfObjectsList[]=500
NumberOfObjectsList[]=1000

Templates #

Variablen, die die Bearbeitungsview für OPML setzt: rss_is_opml, opml_head, opml_items, opml_groups, opml_outline_types, opml_browser_list, opml_browser_pager, opml_browser_search, opml_browser_limits, opml_selected_ids, rss_version_options.

rss_version_array wird weiterhin gesetzt, für Override-Templates, die es verwenden.

Warum der Browser Schaltflächen verwendet #

Der Feed-Browser sitzt innerhalb des Bearbeitungsformulars. Ein Link würde die Seite verlassen und alles mitnehmen, was eingegeben wurde, daher ist jedes Bedienelement — Suche, Seitengröße, Spaltenüberschriften, Seitenzahlen — eine Absende-Schaltfläche, die zuerst den Entwurf schreibt und dann handelt. Die Seite braucht kein JavaScript; das vorhandene Skript vergrößert nur die Klickfläche und lässt die Eingabetaste im Suchfeld suchen statt speichern.

Sicherheit #

Tests: tests/tests/kernel/classes/security/eZRSSSecurityTest.php.

Außerdem:

• Jeder POST, der diese Views erreicht, ist bereits durch ezformtoken abgedeckt, das bei jedem POST eines angemeldeten Benutzers ein Token pro Sitzung prüft und das Feld in jedes Formular einfügt. Die Bedienelemente für OPML erben das.
• Ein Feed, der nicht aktiv ist, wird in einem Dokument nicht aufgeführt. Er kann nicht geholt werden; ihn aufzuführen gäbe einem Leser eine tote Adresse und würde den Namen eines Feeds veröffentlichen, den jemand bewusst außer Betrieb genommen hat.
• Ein Export kann sich nicht selbst aufführen.

Nicht scheitern #

Testen #

Unit- und Sicherheitstests, ohne Datenbank:

php vendor/bin/phpunit --testsuite security     --filter eZRSSSecurityTest
php vendor/bin/phpunit --testsuite kernel-classes --filter eZRSSExportOPMLItemTest

Funktional, gegen eine laufende Installation. Browser- und Kommandozeilenprüfungen für diese Views werden als private Arbeitsskripte gehalten und nicht mitgeliefert; die Schritte von Hand unten sind die unterstützte Entsprechung, und die Unit-Tests oben brauchen keine Datenbank. Legen Sie Beispiel-Feeds in einer Kopie der Installation an, nicht in einer, in der gerade Menschen bearbeiten: Ein zurückgelassener Entwurf sperrt die Bearbeitungsseite eines Exports, bis der Timeout abläuft.

Von Hand:

1. /rss/edit_export/<id> → Feed-Format → OPML 2.0 → OK.
2. Öffnen Sie den Export erneut. Durchsuchen Sie den Browser, ändern Sie die Seitengröße, sortieren Sie eine Spalte, kreuzen Sie einige Feeds an, Ausgewählte Feeds hinzufügen.
3. Gruppe hinzufügen, legen Sie Feeds mit dem Menü In hinein, OK.
4. Holen Sie /rss/feed/<access url> und prüfen Sie es mit einem OPML-Validator.

Führen Sie php vendor/bin/phpunit --list-tests --testsuite security aus, um die Tests zu sehen, ohne sie auszuführen (für diese Seite nicht ausgeführt; führen Sie sie in einer Kopie der Installation aus).

Verwandte Seiten #

• RSS: Feeds für Apple Podcasts, eine Feed-Liste mit Seiten und sicherere Exporte
• Spezifikation der Syndication
• Aufräumen von RSS-Importen
• Der Tab Orte: Blättern und Sortieren (teilt die sortierbare Überschrift)
• September 2026, erste Hälfte: 14. September
• Changelog 6.0.15