include/hiker/bundlemgr.h

Go to the documentation of this file.

/********************************************************************
 *
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright 2006, 2007, ACCESS Systems Americas, Inc. All rights reserved.
 *
 * Version: MPL 1.1/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is hikerproject.org code.
 *
 * The Initial Developer of the Original Code is ACCESS Systems Americas, Inc.
 *               Portions created by the Initial Developer are
 *      Copyright 2006-2007 the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of the LGPL are applicable instead of those above.
 * If you wish to allow use of your version of this file only under the terms
 * of the LGPL, and not to allow others to use your version of this file under
 * the terms of the MPL, indicate your decision by deleting the provisions
 * above and replace them with the notice and other provisions required by
 * the LGPL. If you do not delete the provisions above, a recipient may use
 * your version of this file under the terms of either the MPL or the LGPL.
 * You may obtain a copy of the LGPL at http://www.gnu.org/licenses/lgpl.txt.
 *
 ********************************************************************/
#ifndef ALP_BUNDLEMGR_H_
#define ALP_BUNDLEMGR_H_

#include <hiker/types.h> // for alp_status_t
#include <glib.h> //for gboolean, GList, GArray, gchar
#include <glib-object.h> // for GClosure*

#ifdef __cplusplus
extern "C" {
#endif

// -----------------------------------------------------------------------

alp_status_t alp_bundle_init(void);

alp_status_t alp_bundle_fini(void);


// -----------------------------------------------------------------------
















typedef struct _AlpBundle { guint value; } AlpBundle;

typedef struct _AlpBundleRef * AlpBundleRef;

static inline gboolean alp_bundle_is_NULL(AlpBundle index)
{
        return index.value == 0;
}

#define ALP_BUNDLE_NULL ((struct _AlpBundle){0})

#define ALP_BUNDLE_REF_NULL (NULL)

#define ALP_STATUS_BUNDLEMGR_FAILURE  (ALP_CLASS_BUNDLE | 0x00010000)

#define ALP_STATUS_BUNDLEMGR_CANCELED (ALP_CLASS_BUNDLE | 0x00020000)



// -----------------------------------------------------------------------






AlpBundle alp_bundle_by_name(const char * name);

GArray * alp_bundle_search(const char * name, gboolean named, const char * scheme, const char * store, const char * property);

GList * alp_bundle_list_schemes(void);
GList * alp_bundle_list_stores(void);
GList * alp_bundle_list_names(void);
GList * alp_bundle_list_properties(void);


// -----------------------------------------------------------------------



















AlpBundle alp_bundle_move_to_store(AlpBundle bundle, const char * store, int flags);


AlpBundle alp_bundle_copy_to_store(AlpBundle bundle, const char * store, int flags);

alp_status_t alp_bundle_delete(AlpBundle bundle, int everything);

// metadata includes name, refcount, version, misc data
GHashTable * alp_bundle_metadata(AlpBundle);

gchar * alp_bundle_metadata_value(AlpBundle index, const char * key);

gchar * alp_bundle_rw_pathname(AlpBundle index, const char * file_path, gboolean vivify);

#define ALP_BUNDLE_RW_SAVED     "/saved/"


alp_status_t alp_bundle_rw_delete(AlpBundle index, const char * folder_path, gboolean itself);

GHashTable * alp_bundle_properties(AlpBundle index, const char * property, int which);

GList * alp_bundle_all_properties(AlpBundle index);

gchar * alp_bundle_property_value(AlpBundle index, const char * property, int which, const char * key);

AlpBundle alp_bundle_locate_file(const char * filename);

AlpBundle alp_bundle_me();

AlpBundle alp_bundle_application();


// -----------------------------------------------------------------------

GHashTable * alp_bundle_store(const char * store);

gchar * alp_bundle_store_value(const char * store, const char * key);


// -----------------------------------------------------------------------

AlpBundleRef alp_bundle_open(AlpBundle idx);

alp_status_t alp_bundle_close(AlpBundleRef ref);

AlpBundle alp_bundle_ref_bundle(AlpBundleRef ref);

AlpBundleRef alp_bundle_ref_me();


AlpBundleRef alp_bundle_ref_application();

GIOChannel * alp_bundle_ref_ro_channel(AlpBundleRef ref, const char * path);


gchar * alp_bundle_ref_ro_pathname(AlpBundleRef ref, const char * path);

alp_status_t alp_bundle_ref_ro_data(AlpBundleRef ref, const char * path, gchar ** data, size_t * length);


GList * alp_bundle_ref_ro_directory(AlpBundleRef ref, const char * path, gboolean recurse);

gchar * alp_bundle_ref_ro_tempfile(AlpBundleRef ref, const char * path, gboolean keep, const char * ext);

alp_status_t alp_bundle_tempfile_release(gchar * tempfile);

#define ALP_BUNDLE_BAR_MANIFEST "/Manifest.xml"


// -----------------------------------------------------------------------

typedef struct _AlpBundleProgressiveData AlpBundleProgressiveData;
struct _AlpBundleProgressiveData {
        gint version;
        gboolean (*callback)(AlpBundleProgressiveData*);

        enum {
                ALP_BUNDLE_PROGRESSIVE_HAVE_BYTES_SO_FAR        = 1<<0,
                ALP_BUNDLE_PROGRESSIVE_HAVE_TOTAL_BYTES = 1<<1,
                ALP_BUNDLE_PROGRESSIVE_HAVE_MAX_OVERHEAD        = 1<<2,
                ALP_BUNDLE_PROGRESSIVE_HAVE_METADATA            = 1<<3,
                ALP_BUNDLE_PROGRESSIVE_HAVE_PROPERTIES          = 1<<4,
                ALP_BUNDLE_PROGRESSIVE_HAVE_FILENAME            = 1<<5,
                ALP_BUNDLE_PROGRESSIVE_HAVE_MIMETYPE            = 1<<6,
                ALP_BUNDLE_PROGRESSIVE_HAVE_STORE               = 1<<7,
                ALP_BUNDLE_PROGRESSIVE_HAVE_OVERWRITING_PKGINDEX = 1<<8,
                ALP_BUNDLE_PROGRESSIVE_HAVE_PKGINDEX            = 1<<9,
                ALP_BUNDLE_PROGRESSIVE_HAVE_FINISHED            = 1<<10
        } ALP_BUNDLE_PROGRESSIVE_ENUM;

        guint new_state;

        guint current_state;

        guint bytes_so_far;
        guint total_bytes;
        guint max_overhead;

        GHashTable * metadata;
        GHashTable * properties;
        const char * recommended_filename;
        const char * recommended_mimetype;
        const char * store;
        AlpBundle overwriting_index;
        AlpBundle index;

        void * userdata;
};

enum {
        ALP_BUNDLE_PROGRESSIVE_DATA_VERSION = 1
};


int alp_bundle_image_verify(const char * provide_filename, const char * provide_mimetype, GIOChannel * image, gboolean full_check, GHashTable ** metadata, GHashTable ** properties, AlpBundleProgressiveData * progress);


AlpBundle alp_bundle_image_install(const char * provide_filename, const char * provide_mimetype, GIOChannel * image, const char * destination_store, int flags, GHashTable ** metadata, GHashTable ** properties,  AlpBundleProgressiveData * progress);

alp_status_t alp_bundle_image_archive(AlpBundle index, char ** desired_filename, char ** desired_mimetype, GIOChannel * image, AlpBundleProgressiveData * progress);


// -----------------------------------------------------------------------

GClosure * alp_bundle_acquire_entrypoint(const char * url, AlpBundleRef relativeRef /* may be NULL */);

gchar * alp_bundle_acquire_ro_pathname(const char * url, AlpBundleRef* openRef, AlpBundleRef relativeRef /* may be NULL */);

GIOChannel * alp_bundle_acquire_ro_channel(const char * url, AlpBundleRef relativeRef/* may be NULL */);

alp_status_t alp_bundle_acquire_ro_data(const char * url, gchar ** data, size_t * length, AlpBundleRef relativeRef /* may be NULL */);

gchar * alp_bundle_acquire_ro_tempfile(const char * url, AlpBundleRef* openRef, gboolean keep, const char * ext, AlpBundleRef relativeRef /* may be NULL */);

typedef struct {
  // initial layout should match that of GCClosure
  GClosure      closure;
  gpointer      callback;
  int           struct_version;
  AlpBundleRef  ref;
  void *        dlhandle;
  gchar *       path;
  gchar *       sym;
  int           result_signal;
} AlpBundleEntrypointClosure;

#define ALP_BUNDLE_ENTRYPOINT_CLOSURE_VERSION 1

#define ALP_BUNDLE_ENTRYPOINT_CLOSURE_REF(closure) (((AlpBundleEntrypointClosure*)(closure))->ref)

#define ALP_BUNDLE_ENTRYPOINT_CLOSURE_DLHANDLE(closure) (((AlpBundleEntrypointClosure*)(closure))->dlhandle)

#define ALP_BUNDLE_ENTRYPOINT_CLOSURE_CALLBACK(closure) (((AlpBundleEntrypointClosure*)(closure))->callback)

#define ALP_BUNDLE_ENTRYPOINT_CLOSURE_PATH(closure) (((AlpBundleEntrypointClosure*)(closure))->path)

#define ALP_BUNDLE_ENTRYPOINT_CLOSURE_SYM(closure) (((AlpBundleEntrypointClosure*)(closure))->sym)

#define ALP_BUNDLE_ENTRYPOINT_CLOSURE_RESULT_SIGNAL(closure) (((AlpBundleEntrypointClosure*)(closure))->result_signal)

int alp_bundle_entrypoint_closure_execve(GClosure * closure, char * const argv[], char * const envp[]);

int alp_bundle_entrypoint_closure_execl(GClosure * closure, const char * arg, ...);

// -----------------------------------------------------------------------

#define ALP_NOTIFY_EVENT_BUNDLE_DELETE "/alp/bundlemgr/delete_bundle"
typedef struct _AlpNotifyEventBundleDelete AlpNotifyEventBundleDelete;
struct _AlpNotifyEventBundleDelete {
    AlpBundle index;
    int flags;
    gboolean named;
    char name[];
};

#define ALP_NOTIFY_EVENT_BUNDLE_MOVE "/alp/bundlemgr/move_bundle"
typedef struct _AlpNotifyEventBundleMove AlpNotifyEventBundleMove;
struct _AlpNotifyEventBundleMove {
    AlpBundle index;
    char store[];
};

#define ALP_NOTIFY_EVENT_BUNDLE_COPY "/alp/bundlemgr/copy_bundle"
typedef struct _AlpNotifyEventBundleCopy AlpNotifyEventBundleCopy;
struct _AlpNotifyEventBundleCopy {
    AlpBundle index;
    char store[];
};

#define ALP_NOTIFY_EVENT_BUNDLE_REGISTER "/alp/bundlemgr/register_bundle"
typedef struct _AlpNotifyEventBundleRegister AlpNotifyEventBundleRegister;
struct _AlpNotifyEventBundleRegister {
    AlpBundle index;
};

#define ALP_NOTIFY_EVENT_BUNDLE_UNREGISTER "/alp/bundlemgr/unregister_bundle"
typedef struct _AlpNotifyEventBundleUnregister AlpNotifyEventBundleUnregister;
struct _AlpNotifyEventBundleUnregister {
    AlpBundle index;
};

#define ALP_NOTIFY_EVENT_BUNDLE_RESET_EVERYTHING "/alp/bundlemgr/reset_everything"
typedef struct _AlpNotifyEventBundleResetEverything AlpNotifyEventBundleResetEverything;
struct _AlpNotifyEventBundleResetEverything {
};

#define ALP_NOTIFY_EVENT_BUNDLE_NAME_ADDED "/alp/bundlemgr/name_added"
typedef struct _AlpNotifyEventBundleNameAdded AlpNotifyEventBundleNameAdded;
struct _AlpNotifyEventBundleNameAdded {
    AlpBundle index;
    char name[];
};

#define ALP_NOTIFY_EVENT_BUNDLE_NAME_REMOVED "/alp/bundlemgr/name_removed"
typedef struct _AlpNotifyEventBundleNameRemoved AlpNotifyEventBundleNameRemoved;
struct _AlpNotifyEventBundleNameRemoved {
    AlpBundle index;
    char name[];
};

#define ALP_NOTIFY_EVENT_BUNDLE_NAME_CHANGED "/alp/bundlemgr/name_changed"
typedef struct _AlpNotifyEventBundleNameChanged AlpNotifyEventBundleNameChanged;
struct _AlpNotifyEventBundleNameChanged {
    AlpBundle old_index;
    AlpBundle new_index;
    char name[];
};

#define ALP_NOTIFY_EVENT_BUNDLE_STORE_ADDED "/alp/bundlemgr/store_added"
typedef char AlpNotifyEventBundleStoreAdded[];

#define ALP_NOTIFY_EVENT_BUNDLE_STORE_REMOVED "/alp/bundlemgr/store_removed"
typedef char AlpNotifyEventBundleStoreRemoved[];



// -----------------------------------------------------------------------

#define ALP_BUNDLE_PROPERTY_APPLICATION "application"



// -----------------------------------------------------------------------

#define ALP_BUNDLE_TYPE_BAR     "bar"

#define ALP_BUNDLE_TYPE_GVM     "GHost"

#define ALP_BUNDLE_TYPE_JAVA    "java"


#define ALP_BUNDLE_SCHEME_EXTENSION_BAR         ".bar"

#define ALP_BUNDLE_SCHEME_EXTENSION_GVM         ".prc"

#define ALP_BUNDLE_SCHEME_EXTENSION_JAVA        ".jar"

// From:
//  http://www.iana.org/assignments/media-types/application/vnd.palm
//  http://developers.sun.com/techtopics/mobility/midp/articles/deploy/

#define ALP_BUNDLE_SCHEME_MIMETYPE_BAR          "x-application/access-bar"

#define ALP_BUNDLE_SCHEME_MIMETYPE_GVM          "application/vnd.palm"

#define ALP_BUNDLE_SCHEME_MIMETYPE_GVM_2        "application/x-pilot"

#define ALP_BUNDLE_SCHEME_MIMETYPE_JAVA         "application/java-archive"

#define ALP_BUNDLE_SCHEME_MIMETYPE_JAVA_2       "text/vnd.sun.j2me.app-descriptor"


// -----------------------------------------------------------------------

#define ALP_BUNDLE_FINGERTOUCH_RSC_PREFIX "finger-"

#define ALP_BUNDLE_FLAG_DELETE_EVERYTHING 1

#define ALP_BUNDLE_FLAG_OVERWRITE_DUPLICATE 128


const char * alp_bundle_ref_gettextdomain(AlpBundleRef ref);

const char * alp_bundle_ref_name(AlpBundleRef ref);

gchar * alp_bundle_name(AlpBundle index);

gchar * alp_bundle_saved_settings(AlpBundle index, const char * key);

gchar * alp_bundle_unsaved_settings(AlpBundle index, const char * key);


#define alp_bundle_acquire_glade_xml(url, root) \
({                                                      \
  AlpBundleRef _ref;                                    \
  AlpBundleRef _me = alp_bundle_ref_me();               \
  gchar * _pathname = alp_bundle_acquire_ro_pathname((url), &_ref, _me);        \
  GladeXML * _result = glade_xml_new_with_domain(_pathname, (root), alp_bundle_ref_gettextdomain(_ref));        \
  g_free(_pathname);                                    \
  alp_bundle_close(_ref);                               \
  _result;                                              \
})

#define alp_bundle_ref_cgettext(ref, text, category)            \
  dcgettext(alp_bundle_ref_gettextdomain((ref)), (text), (category))    \


#define alp_bundle_ref_gettext(ref, text)                       \
  dgettext(alp_bundle_ref_gettextdomain((ref)), (text)) \


#define alp_bundle_gettext(text)                                \
  dgettext(alp_bundle_ref_gettextdomain(alp_bundle_ref_me()), (text))

alp_status_t alp_bundle_error(void);



// -----------------------------------------------------------------------
GHashTable * alp_bundle_scheme_values(const char * scheme);

gchar * alp_bundle_scheme_value(const char * scheme, const char * key);

gchar * alp_bundle_scheme_identify(const char * filename, const char * mimetype);




#ifdef __cplusplus
}
#endif


#endif /* ALP_BUNDLEMGR_H_ */

---

Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.