---

Class Relations

• class: ::xowiki::Object

::xowiki::Object create ::xowiki::exporter

Methods (to be applied on the object)

• export (scripted)

  #
  # include implicitly needed objects, instantiate the objects.
  #
  set item_ids [:include_needed_objects $item_ids]
  #
  # stream the objects via ns_write
  #
  ns_set put [ns_conn outputheaders] "Content-Type" "text/plain"
  ns_set put [ns_conn outputheaders] "Content-Disposition" "attachment;filename=export.xotcl"
  ad_return_top_of_page ""
  
  foreach item_id $item_ids {
    ns_log notice "--exporting $item_id [::$item_id name]"
    set pretty_link [expr {[::$item_id package_id] ne "" ? [::$item_id pretty_link] : "(not visible)"}]
    ns_write "# exporting $item_id [::$item_id name] $pretty_link\n"
    ad_try {
      set obj [::$item_id marshall]
    } on error {errorMsg} {
      ns_log error "Error while exporting $item_id [::$item_id name]\n$errorMsg\n$::errorInfo"
    } finally {
      ns_write "$obj\n"
    }
  }

• include_needed_objects (scripted)

  #
  # Load the objects
  #
  foreach item_id $item_ids {
    if {[::xo::db::CrClass get_instance_from_db -item_id $item_id] eq ""} {
      :log "Warning: cannot fetch item $item_id for exporting"
    } else {
      set items($item_id) 1
    }
  }
  
  #
  # In a second step, include the objects which should be exported implicitly
  #
  while {1} {
    set new 0
    if {[array size items] > 0} {
      ns_log notice "--export works on [array size items] items: [array names items]"
    }
    foreach item_id [array names items] {
      #
      # We flag the reason, why the implicitly included elements were
      # included. If the target can resolve already such items
      # (e.g. forms), we might not have to materialize these finally.
      #
      # For PageInstances (or its subtypes), include the parent-objects as well
      #
      if {[::$item_id istype ::xowiki::PageInstance]} {
        set template_id [::$item_id page_template]
        if {![info exists items($template_id)]} {
          ns_log notice "--export including template-object $template_id of item $item_id has name? [::$template_id exists name]"
          ns_log notice "--export including template-object $template_id [::$template_id name]"
          set items($template_id) 1
          ::xo::db::CrClass get_instance_from_db -item_id $template_id
          set new 1
          ::$template_id set __export_reason implicit_page_template
          continue
        }
      }
      #
      # check for child objects of the item
      #
      set sql [::xowiki::Page instance_select_query -folder_id $item_id -with_subtypes true]
      ::xo::dc foreach export_child_obj $sql {
        if {![info exists items($item_id)]} {
          ns_log notice "--export child $item_id not included, try to fetch"
          ::xo::db::CrClass get_instance_from_db -item_id $item_id
          ns_log notice "--export including child $item_id [::$item_id name]"
          set items($item_id) 1
          set new 1
          ::$item_id set __export_reason implicit_child_page
        }
      }
    }
    if {!$new} {
      break
    }
  }
  return [array names items]

• marshall_all (scripted)

  set content ""
  foreach item_id $item_ids {
    ad_try {
      set obj [::$item_id marshall -mode $mode]
    } on error {errorMsg} {
      ns_log error "Error while exporting $item_id [::$item_id name]\n$errorMsg\n$::errorInfo"
      error $errorMsg
    }
    append content $obj\n
  }
  return $content

• marshall_all_to_file (scripted)

  #
  # This method is similar to "marshall_all", but exports the objects
  # directly to a file. This can save memory when exporting a large
  # collection of objects, since the plain "marshall_all" appends to
  # a string, which can get very large, especially due to Tcl's
  # "double the size when space is needed" policy during "append"
  # operations.
  #
  set output_file [open $filename w]
  foreach item_id $item_ids {
    ad_try {
      puts $output_file [::$item_id marshall -mode $mode]
      if {$cleanup && [info exists ::xo::cleanup(::$item_id)]} {
        {*}$::xo::cleanup(::$item_id)
      }
    } on error {errorMsg} {
      ns_log error "Error while exporting $item_id [::$item_id name]\n$errorMsg\n$::errorInfo"
      error $errorMsg
    } finally {
      close $output_file
    }
  }

---