123
edits
Changes
Jump to navigation
Jump to search
mLine 10:
Line 10: + Line 18:
Line 19: − + Line 26:
Line 27: − + Line 32:
Line 33: − + − + − + + + Line 46:
Line 49: − + − + Line 88:
Line 91: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Line 117:
Line 201: + − + Line 128:
Line 213: − − − [[Category:Feature Page Incomplete]] − [[Category:Feature]]
User:Alsroot/trash/Object Bundles (view source)
Revision as of 14:27, 1 March 2010
, 14:27, 1 March 2010moved Walter is a wanker 6/trash/Object Bundles to User:Alsroot/trash/Object Bundles over redirect: revert
* package Journal objects to bundles to preserve sugar related metadata
* package Journal objects to bundles to preserve sugar related metadata
* support composite Journal objects e.g. in case of library bundles instead of having .xol in Journal and unpacked files in ~/Library, all library files will be represented by one Journal entry, could be opened in Browse(''[Metadata]/mime_type'' should be text/html for that purpose) and could be transformed back to .xo on demand(e.g. for uploading library in Browse's pick-file field).
* support composite Journal objects e.g. in case of library bundles instead of having .xol in Journal and unpacked files in ~/Library, all library files will be represented by one Journal entry, could be opened in Browse(''[Metadata]/mime_type'' should be text/html for that purpose) and could be transformed back to .xo on demand(e.g. for uploading library in Browse's pick-file field).
* Object Bundles exist only out of sugar (after uploading to the Journal .xo will be removed)
== Owner ==
== Owner ==
== Current status ==
== Current status ==
* Targeted release: 0.86
* Targeted release:
* Last updated: Mon Jul 27 05:31:42 UTC 2009
* Last updated: Mon Jul 27 05:31:42 UTC 2009
* Percentage of completion: 75%
* Percentage of completion: 75%
This feature is a first approach to unified format for all types of bundles(in 0.86 it will support only Journal entries and new library bundles).
This feature is a first approach to unified format for all types of bundles(in 0.86 it will support only Journal entries and new library bundles).
Object bundle should have ''METADATA'' file in top directory of .xo bundle.
Object bundle should have ''METADATA'' file in the top directory of .xo bundle.
=== METADATA file ===
=== METADATA file ===
This file is in [http://docs.python.org/library/configparser.html INI] format which describes how to setup bundle.
This file is in [http://docs.python.org/library/configparser.html INI] format which describes how to setup bundle.
Object bundle can be installed to Journal in two forms:
Object bundle can be installed to Journal in two forms.
* files from bundle will be unpacked and installed as separate Journal entries, bundle itself will be removed(similar to .xoj)<br>final Journal entries can have ''activity'' field, so they are regular Journal entries that imported to Journal(w/o ''activity'' field) or created by activities(with ''activity'' field)<br>''METADATA'' should contain ''[Entry]'' sections for each Journal entry<br>if bundle has more then one entry, sections should be parted by different suffixes e.g. ''[Entry2]'', ''[Entry.additional]'' etc.
* bundle will be installed as a composite object i.e. as a directory of packaged to the bundle files that are represented by one Journal entry<br>final Journal entry can't have ''activity'' field<br>''METADATA'' should contain only one ''[Bundle]'' section
* '''Each file from bundle as separate Journal entry'''<br>files from bundle will be unpacked and installed as separate Journal entries, bundle itself will be removed(similar to .xoj)<br>final Journal entries can have ''activity'' field, so they are regular Journal entries that imported to Journal(w/o ''activity'' field) or created by activities(with ''activity'' field)<br>''METADATA'' should contain ''[Entry]'' sections for each Journal entry<br>if bundle has more then one entry, sections should be parted by different suffixes e.g. ''[Entry2]'', ''[Entry.additional]'' etc.
* '''Composite Journal entry'''<br>bundle will be installed as a composite object i.e. as a directory of packaged to the bundle files that are represented by one Journal entry<br>final Journal entry can't have ''activity'' field<br>''METADATA'' should contain only one ''[Bundle]'' section
METADATA file can have one or several sections(depends on installation method) that describe metadata fields of final entry(ies) in Journal.
METADATA file can have one or several sections(depends on installation method) that describe metadata fields of final entry(ies) in Journal.
| ''entry''
| ''entry''
| mandatory
| mandatory
| if bundle is composite, ''entry'' defines access point to composite object (e.g. index.html for library bundles); otherwise it defines file which will be installed to Journal
| if bundle is composite, ''entry'' defines access point to composite object (e.g. index.html for library bundles);<br>otherwise it defines file which will be installed to Journal
|-
|-
| ''mime_type''
| ''mime_type''
| mandatory
| mandatory
| define metadata for a file which will be stored in Journal
| define metadata for final Journal entry
|-
|-
| ''uid''
| ''uid''
* [http://git.sugarlabs.org/projects/sugar-toolkit/repos/objectbundle sugar-toolkit]
* [http://git.sugarlabs.org/projects/sugar-toolkit/repos/objectbundle sugar-toolkit]
* [http://git.sugarlabs.org/projects/browse/repos/objectbundle Browse]
* [http://git.sugarlabs.org/projects/browse/repos/objectbundle Browse]
Example of PHP code which could be used on server side to unpack object bundles to get metadata (like title, description, preview etc.)
require_once('Archive/Zip.php');
function rmtree($dir) {
$dir = "$dir";
if ($dh = opendir($dir)) {
while (FALSE !== ($item = readdir($dh))) {
if ($item != '.' && $item != '..') {
$subdir = $dir . '/' . "$item";
if (is_dir($subdir))
rmtree($subdir);
else
unlink($subdir);
}
}
closedir($dh);
rmdir($dir);
}
}
function unbundle($bundle) {
$zip = new Archive_Zip($bundle);
$tmpdir = tempnam('/tmp', 'sugar');
if (file_exists($tmpdir))
unlink($tmpdir);
if (!mkdir($tmpdir)) {
return null;
}
$out = $zip->extract(array('add_path' => $tmpdir, 'by_name' => array('METADATA')));
if (empty($out)) {
rmtree($tmpdir);
return null;
}
$metadata = parse_ini_file($out[0]['filename'], true);
if (!$metadata) {
rmtree($tmpdir);
return null;
}
$result = array();
foreach ($metadata as $section => $items) {
if (!(substr($section, 0, 5) == 'Entry' || $section == 'Bundle'))
continue;
foreach ($items as $name => $value) {
if (substr($name, -5) == '_file') {
$name = substr($name, 0, -5);
$out = $zip->extract(array('add_path' => $tmpdir, 'by_name' => array($value)));
if (empty($out)) {
rmtree($tmpdir);
return null;
}
$value = file_get_contents($tmpdir.'/'.$value);
}
$result[$name] = $value;
}
break;
}
rmtree($tmpdir);
return $result;
}
// example usage of unbundle() function
$bundle = 'foo.xo';
$metadata = unbundle($bundle);
if (!$metadata)
echo 'Can not open '.$bundle."\n";
else
foreach ($metadata as $name => $value)
echo $name.'='.$value."\n";
== How To Test ==
== How To Test ==
== Documentation ==
== Documentation ==
* [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg06874.html Email thread]
* [[Unified Bundles]]
* [[Unified Bundles]]
* [[Unified Objects]]
* [[User:Alsroot/trash/Unified Objects | Unified Objects]]
* [http://wiki.laptop.org/go/Journal_entry_bundles Journal entry bundles]
* [http://wiki.laptop.org/go/Journal_entry_bundles Journal entry bundles]
* [http://wiki.laptop.org/go/Bundle_concepts Bundle concepts]
* [http://wiki.laptop.org/go/Bundle_concepts Bundle concepts]
== Comments and Discussion ==
== Comments and Discussion ==
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page. This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page. This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->