Skip to content

A
attachments
Commit def3b677 authored by Frank Bergmann's avatar Frank Bergmann
Browse files
Options

- OpenACS 5.9

parent 05c7408a
Hide whitespace changes
Inline Side-by-side
Showing with 213 additions and 7 deletions
attachments.info
View file @ def3b677
......@@ -12,13 +12,13 @@
<owner url="http://openacs.org">OpenACS</owner>
<summary>Attachment support</summary>
<maturity>2</maturity>
<release-date>2013-09-08</release-date>
<release-date>2015-10-04</release-date>
<vendor url="http://openacs.org">OpenACS</vendor>
<description format="text/plain">Provide widgets and datamodel to support attachments on arbitrary objects. Used by forums.</description>
<provides url="attachments" version="0.11d2"/>
<requires url="acs-kernel" version="5.8.1"/>
<requires url="file-storage" version="5.8.1"/>
<requires url="acs-kernel" version="5.9.0"/>
<requires url="file-storage" version="5.9.0"/>
<parameters>
<parameter datatype="string" min_n_values="1" max_n_values="1" name="RelativeUrl" default="attach" description="The relative url of this package when mounted under a client."/>
......
tcl/attachments-procs.tcl
View file @ def3b677
......@@ -222,3 +222,9 @@ namespace eval attachments {
}
}
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/admin/new-root-folder-map-2.tcl
View file @ def3b677
......@@ -37,3 +37,9 @@ attachments::map_root_folder -package_id $package_id -folder_id $folder_id
ad_returnredirect $referer
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/admin/new-root-folder-map.tcl
View file @ def3b677
......@@ -66,3 +66,9 @@ if {$root_folder_id == 0} {
}
}
}
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/admin/redirect.tcl
View file @ def3b677
......@@ -21,3 +21,9 @@ ad_page_contract {
{referer:notnull}
}
ad_returnredirect $referer
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/attach-2.tcl
View file @ def3b677
......@@ -24,3 +24,9 @@ if {[catch {
}
ad_returnredirect $return_url
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/attach.tcl
View file @ def3b677
......@@ -83,3 +83,9 @@ template::head::add_style -style "
set file_add_url [export_vars -base "file-add" { {object_id $to_object_id} folder_id return_url pretty_object_name}]
set simple_add_url [export_vars -base "simple-add" { {object_id $to_object_id} folder_id return_url pretty_object_name}]
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/detach.tcl
View file @ def3b677
......@@ -79,4 +79,9 @@ ad_form \
}
} -after_submit {
ad_returnredirect $return_url
}
\ No newline at end of file
}
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/doc/index.adp 0 → 100644
View file @ def3b677
<property name="context">{/doc/attachments {Attachments}} {}</property>
<property name="doc(title)"></property>
<master>
<h1><a id="id.toc" name="id.toc">Contents</a></h1>
<dl><dd>
<a href="#id.s1">1 Attachments</a><dl>
<dd>
<a href="#id.s1.1">1.1 Basics</a><dl>
<dd><a href="#id.s1.1.1">1.1.1 What does attachments do?</a></dd><dd><a href="#id.s1.1.2">1.1.2 At a high level, how does
attachments work?</a></dd>
</dl>
</dd><dd>
<a href="#id.s1.2">1.2 Using attachments</a><dl>
<dd><a href="#id.s1.2.1">1.2.1 Mount attachments under your
package</a></dd><dd><a href="#id.s1.2.2">1.2.2 Map an file-storage root folder to
your package instance</a></dd><dd>
<a href="#id.s1.2.3">1.2.3 Attaching files to your objects</a><dl>
<dd><a href="#id.s1.2.3.1">1.2.3.1 Have your package check if
attachments is mounted properly</a></dd><dd><a href="#id.s1.2.3.2">1.2.3.2 Get the attachment Url</a></dd>
</dl>
</dd><dd><a href="#id.s1.2.4">1.2.4 Viewing attached files</a></dd>
</dl>
</dd>
</dl>
</dd></dl>
<hr>
<h1>1 Attachments</h1>
<h2>
<a id="id.s1.1" name="id.s1.1">1.1</a> Basics</h2>
<h3>
<a id="id.s1.1.1" name="id.s1.1.1">1.1.1</a> What does
attachments do?</h3>
<p>
<tt>attachments</tt> is a service package that allows you to
attach one or more file-storage files to any <tt>acs_object</tt>.
<tt>attachments</tt> is mounted below a package that uses it, and
the application provides links into the attachments package's
UI.</p>
<h3>
<a id="id.s1.1.2" name="id.s1.1.2">1.1.2</a> At a high level,
how does attachments work?</h3>
<p>Before you can use the attachments package, each instance of
your package must be mapped to a <tt>file-storage root
folder</tt>.</p>
<p>The root folder is a "super folder" for all the files in that
specific instance of file-storage, and it is created automatically
when the file-storage package is instanciated.</p>
<p>When a user wants to make an attachment to an object in your
package, she is shown the contents of the file-storage root folder
mapped to your package instance. The user is also given the option
to upload a new file into file-storage to attach.</p>
<h2>
<a id="id.s1.2" name="id.s1.2">1.2</a> Using attachments</h2>
<h3>
<a id="id.s1.2.1" name="id.s1.2.1">1.2.1</a> Mount attachments
under your package</h3>
<p>The first step is to mount the attachments package <b>under</b>
your package. In the <tt>site-map</tt>, you should create a new
site-node (sub-folder) under your package called "attach".</p>
<p>"attach" is the standard URL, however URL this can be changed on
a site-wide basis by changing the "RelativeUrl" parameter of
<b>any</b> of the attachments packages (this works since there's
only one instance of attachments in the entire system. The same
instance is just re-mounted)</p>
<h3>
<a id="id.s1.2.2" name="id.s1.2.2">1.2.2</a> Map an
file-storage root folder to your package instance</h3>
<p>First, you must select a file-storage instance that will provide
the files you can attach. If you do not already have an instance of
file-storage that you want to use for your package instance, you
must create one using the site-map.</p>
<p>Once you have a file-storage instance you wish to use, you must
map the root folder of that file-storage instance with the
package_id of the instance of your package.</p>
<p>Two utility procs to help you do this:</p>
<p>
<tt>fs::get_root_folder</tt> and
<tt>attachments::map_root_folder</tt>
</p>
<h3>
<a id="id.s1.2.3" name="id.s1.2.3">1.2.3</a> Attaching files to
your objects</h3>
<h4>
<a id="id.s1.2.3.1" name="id.s1.2.3.1">1.2.3.1</a> Have your
package check if attachments is mounted properly</h4>
<p>Most likely, you want your package to work even if the
attachments package is not installed on the system or if
attachments is not properly mounted. To do this, add the following
proc to your package's API and wrap all calls to the attachments
package with it:</p>
<div class="box" style="border: 2px solid; width: 100%"><pre>
ad_proc -private attachments_enabled_p {} {
set package_id [site_node_apm_integration::child_package_exists_p \
-package_key attachments
]
}
</pre></div>
<h4>
<a id="id.s1.2.3.2" name="id.s1.2.3.2">1.2.3.2</a> Get the
attachment Url</h4>
<p>When you want to set up the link that the user can click on to
attach something to an object, use the
attachments::add_attachment_url proc, which will return the correct
Url into the attachments package mounted under your package.</p>
<div class="box" style="border: 2px solid; width: 100%"><pre>
if {$attachments_enabled_p} {
if {$attach_p} {
set redirect_url [attachments::add_attachment_url \
-object_id $message_id \
-return_url $redirect_url \
-pretty_name "$subject"]
}
}
</pre></div>
<p>forums redirects the user to the redirect_url, if the user chose
to add an attachment to their posting.</p>
<h3>
<a id="id.s1.2.4" name="id.s1.2.4">1.2.4</a> Viewing attached
files</h3>
<p>You can use the "attachments::get_attachments" proc to see the
list of attachments to a given object.</p>
<h2>Release Notes</h2>
<p>Please file bugs in the <a href="http://openacs.org/bugtracker/openacs/">Bug Tracker</a>.</p>
www/doc/index.html
View file @ def3b677
......@@ -26,8 +26,7 @@ mounted properly</a></dd>
</dl></dd>
</dl></dd>
</dl><hr>
<h1><a id="id.s1" name="id.s1">1
</a>Attachments<a href="#id.toc"><img src="apt_toc.gif" style="border-style: none; border-width: 0" width="30" height="11" alt="Contents"></a></h1>
<h1>1 Attachments</h1>
<h2><a id="id.s1.1" name="id.s1.1">1.1 </a>Basics</h2>
<h3><a id="id.s1.1.1" name="id.s1.1.1">1.1.1 </a>What does attachments
do?</h3>
......@@ -92,5 +91,11 @@ chose to add an attachment to their
posting.</p><h3><a id="id.s1.2.4" name="id.s1.2.4">1.2.4 </a>Viewing attached
files</h3>
<p>You can use the &quot;attachments::get_attachments&quot; proc to see the
list of attachments to a given object.</p></body>
list of attachments to a given object.</p>
<h2>Release Notes</h2>
<p>Please file bugs in the <a href="http://openacs.org/bugtracker/openacs/">Bug Tracker</a>.</p>
</body>
</html>
www/file-add-2.tcl
View file @ def3b677
......@@ -76,3 +76,9 @@ set fs_package_id [db_string get_fs_package_id {}]
ad_returnredirect $return_url
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/file-add.tcl
View file @ def3b677
......@@ -41,3 +41,9 @@ if {$title eq ""} {
set lock_title_p 0
}
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/go-to-attachment.tcl
View file @ def3b677
......@@ -55,3 +55,9 @@ switch $content_type {
return
}
}
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/simple-add-2.tcl
View file @ def3b677
......@@ -34,3 +34,9 @@ db_transaction {
}
ad_returnredirect "$return_url"
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/simple-add.tcl
View file @ def3b677
......@@ -45,3 +45,9 @@ set context [_ attachments.Add_pretty_name [list pretty_name $pretty_name]]
if {$title eq ""} {
set lock_title_p 0
}
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
www/toggle-approved.tcl
View file @ def3b677
......@@ -14,3 +14,9 @@ ad_page_contract {
attachments::toggle_approved -object_id $object_id -item_id $item_id -approved_p $approved_p
ad_returnredirect $return_url
# Local variables:
# mode: tcl
# tcl-indent-level: 4
# indent-tabs-mode: nil
# End:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment