undefined<\/code> handles the item. This is a\nreplacement hook, not a property transformation fold.<\/p>\nDeclare -behaviour(zotonic_observer)<\/code> and export observe_import_resource\/2<\/code> or\npid_observe_import_resource\/3<\/code>. Both callbacks are optional. The behaviour does\nnot define records: include zotonic_core\/include\/zotonic.hrl<\/code><\/strong> in every module\nusing #import_resource{}<\/code>.<\/p>\n-behaviour(zotonic_observer).\n-include_lib("zotonic_core\/include\/zotonic.hrl").\n-export([observe_import_resource\/2]).\n\nobserve_import_resource(#import_resource{\n source = #{importer := mod_import_feed, feed := Feed},\n item = Item\n}, Context) ->\n my_importer:import(Item, Feed, Context);\nobserve_import_resource(_, _) ->\n undefined.\n<\/code><\/pre>\nPayload<\/h2>\nitem<\/code>: a map with binary source uri<\/code> and binary-keyed resource props<\/code>.\nOptional edges<\/code> contains {Predicate, Object}<\/code> pairs; references can be local\nIDs, names, source URIs or remote resource-reference maps. medium<\/code> is a source\nURL, a media description map, or undefined<\/code>. Importers may add fields, such as\nid<\/code>, media_aliases<\/code>, or the native feed's zotonic_export<\/code> and native_options<\/code>.<\/li>related<\/code>: known related item maps, not a fully fetched recursive graph. Entries\nmarked is_reference => true<\/code> have only identity information. Their presence\ndoes not imply ownership or is_dependent<\/code> on the imported resource.<\/li>source<\/code>: importer metadata. importer<\/code> identifies the producer. Feeds use\n#{importer => mod_import_feed, feed => Settings}<\/code>; native imports use\n#{importer => m_rsc_import, uri => Uri}<\/code>. Feed settings omit lease tokens and\nsaved ACL groups.<\/li>options<\/code>: native import options when applicable, otherwise an empty list.\nFeed-specific policy is in the source's feed<\/code> settings.<\/li>raw<\/code>: original parsed input. For feeds this is XML, optionally accompanied by\nWordPress JSON; for native imports it is the decoded resource export.<\/li><\/ul>\nTiming and permissions<\/h2>\n
Feed entries notify after preparation and unchanged\/deleted checks, inside their\nentry transaction. Native resource imports notify after category eligibility is\nchecked but before reference mapping can create resources. Local-URI lookups do\nnot notify. Resource properties and raw input remain untrusted; handlers must use\nnormal resource\/media APIs, sanitize input and enforce import policies.<\/p>\n
The supplied context retains the importing user's permissions. No automatic\nsudo<\/code> or transaction is introduced by z_import_resource:import\/3<\/code>. Reuse the\nsupplied context for delegation and writes. Delegating the same URI to another\nparticipating importer does not notify again; different URIs do. Thus native feed\nroots notify once and recursively imported resources can notify separately.<\/p>\nResults<\/h2>\nundefined<\/code>: continue to other observers, then the default importer.<\/li>{ok, Id}<\/code>: the observer has completed the import. The resource must be editable\nby the importing user.<\/li>{ok, Id, UriToIdMap}<\/code>: additionally return imported related resources. Keys must\nbe binary source URIs and values integer IDs visible to the importing user.<\/li>{skip, Reason}<\/code>: deliberately skip. Feeds record the skip; m_rsc_import<\/code>\nreturns {error, {skipped, Reason}}<\/code> to preserve its public result contract.<\/li>{error, Reason}<\/code>: fail. Feeds roll back their entry transaction; other importers\nretain their own transaction policy. External effects cannot be rolled back.<\/li><\/ul>\nMalformed results return {error, invalid_observer_result}<\/code> and inaccessible IDs\nreturn {error, eacces}<\/code>. Do not return success before asynchronous writes finish.\nThe caller retains import history and completion handling: native imports save\nimport options and emit #rsc_import_done{}<\/code> even when an observer handles them.<\/p>\nThis notification is emitted by the feed and native resource importers. CSV\/XLSX,\nWordPress WXR\/datamodel imports and ordinary media uploads do not yet emit it.<\/p>","slug":"observe_import_resource-2","is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"1faef0718b2d31fa09e1727e58abe5c52b01d45e99ba424ed86a07afc18cfad4","is_featured":false,"notification":{"arity":2,"callbacks":[{"arity":2,"name":"observe_import_resource","signature":"observe_import_resource\/2","variation":"observe"},{"arity":3,"name":"pid_observe_import_resource","signature":"pid_observe_import_resource\/3","variation":"pid_observe"}],"name":"import_resource","record":{"item":"undefined","options":"[]","raw":"undefined","related":"[]","source":"#{}"}},"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"category_id":{"id":1122,"is_a":["meta","category"],"name":"notification","title":"Notifications","uri":"https:\/\/test.zotonic.com\/id\/1122"},"doc_source_path":"apps\/zotonic_core\/src\/behaviours\/zotonic_observer.erl","publication_start":"2023-01-30T19:23:59Z","github_url":"https:\/\/github.com\/zotonic\/zotonic\/blob\/master\/apps\/zotonic_core\/src\/behaviours\/zotonic_observer.erl","pivot_location_lng":null,"doc_source_kind":"notification","name":"doc_notification_import_resource","is_unfindable":false,"is_published":true,"pivot_geocode":null,"created":"2020-05-30T05:47:35Z","uri":null,"doc_status":"current","is_dependent":false,"publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"9542d51dd051382bb67b08e5659311d8bb2b37e0\n","creator_id":{"id":336,"is_a":["person","robot"],"name":"gitbot","title":"Git","uri":"https:\/\/zotonic.com\/id\/336"},"modified":"2026-10-20T16:40:19Z","title_slug":"observe_import_resource-2"},"uri":"https:\/\/zotonic.com\/id\/1780","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/1780"}},"status":"ok"}