Files | |
file | qofsession.h |
Encapsulates a connection to a backend (persistent store). | |
Defines | |
#define | QOF_MOD_SESSION "qof-session" |
#define | QOF_STDOUT "file:" |
Allow session data to be printed to stdout. | |
Typedefs | |
typedef struct _QofSession | QofSession |
typedef void(* | QofPercentageFunc )(const gchar *message, gdouble percent) |
Functions | |
QofSession * | qof_session_new (void) |
void | qof_session_destroy (QofSession *session) |
void | qof_session_swap_data (QofSession *session_1, QofSession *session_2) |
void | qof_session_begin (QofSession *session, const gchar *book_id, gboolean ignore_lock, gboolean create_if_nonexistent) |
void | qof_session_load (QofSession *session, QofPercentageFunc percentage_func) |
void | qof_session_add_book (QofSession *session, QofBook *book) |
QofBook * | qof_session_get_book (QofSession *session) |
const gchar * | qof_session_get_file_path (QofSession *session) |
const gchar * | qof_session_get_url (QofSession *session) |
gboolean | qof_session_not_saved (QofSession *session) |
gboolean | qof_session_save_may_clobber_data (QofSession *session) |
void | qof_session_save (QofSession *session, QofPercentageFunc percentage_func) |
void | qof_session_end (QofSession *session) |
void | qof_session_add_close_hook (GFunc fn, gpointer data) |
void | qof_session_call_close_hooks (QofSession *session) |
Copying entities between sessions. | |
Only certain backends can cope with selective copying of entities and only fully defined QOF entities can be copied between sessions - see the QOF Serialisation Format (QSF) documentation (qsf_write_file) for more information. The recommended backend for the new session is QSF or a future SQL backend. Using any of these entity copy functions sets a flag in the backend that this is now a partial QofBook. See Reference: Referring to entities outside a partial book.. When you save a session containing a partial QofBook, the session will check that the backend is able to handle the partial book. If not, the backend will be replaced by one that can handle partial books, preferably one using the same access_method. Currently, this means that a book using the GnuCash XML v2 file backend will be switched to QSF. Copied entities are identical to the source entity, all parameters defined with QofAccessFunc and QofSetterFunc in QOF are copied and the GUID of the original QofEntity is set in the new entity. Sessions containing copied entities are intended for use as mechanisms for data export. It is acceptable to add entities to new_session in batches. Note that any of these calls will fail if an entity already exists in new_session with the same GUID as any entity to be copied.
To merge a whole QofBook or where there is any possibility of collisions or requirement for user intervention, see Merge: Merging QofBook structures | |
gboolean | qof_entity_copy_to_session (QofSession *new_session, QofEntity *original) |
Copy a single QofEntity to another session. | |
gboolean | qof_entity_copy_list (QofSession *new_session, GList *entity_list) |
Copy a GList of entities to another session. | |
gboolean | qof_entity_copy_coll (QofSession *new_session, QofCollection *entity_coll) |
Copy a QofCollection of entities. | |
gboolean | qof_entity_copy_coll_r (QofSession *new_session, QofCollection *coll) |
Recursively copy a collection of entities to a session. | |
gboolean | qof_entity_copy_one_r (QofSession *new_session, QofEntity *ent) |
Recursively copy a single entity to a new session. | |
Event Handling | |
gboolean | qof_session_events_pending (QofSession *session) |
gboolean | qof_session_process_events (QofSession *session) |
This class provides several important services:
1) It resolves and loads the appropriate backend, based on the URL.
2) It reports backend errors (e.g. network errors, storage corruption errors) through a single, backend-independent API.
3) It reports non-error events received from the backend.
4) It helps manage global dataset locks. For example, for the file backend, the lock prevents multiple users from editing the same file at the same time, thus avoiding lost data due to race conditions. Thus, an open session implies that the associated file is locked.
5) Misc utilities, such as a search path for the file to be edited, and/or other URL resolution utilities. This should simplify install & maintenance problems for naive users who may not have a good grasp on what a file system is, or where they want to keep their data files.
6) In the future, this class is probably a good place to manage a portion of the user authentication process, and hold user credentials/cookies/keys/tokens. This is because at the coarsest level, authorization can happen at the datastore level: i.e. does this user even have the authority to connect to and open this datastore?
A brief note about books & sessions: A book encapsulates the datasets manipulated by QOF. A book holds the actual data. By contrast, the session mediates the connection between a book (the thing that lives in virtual memory in the local process) and the datastore (the place where book data lives permanently, e.g., file, database).
In the current design, a session may hold multiple books. For now, exactly what this means is somewhat vague, and code in various places makes some implicit assumptions: first, only one book is 'current' and open for editing. Next, its assumed that all of the books in a session are related in some way. i.e. that they are all earlier accounting periods of the currently open book. In particular, the backends probably make that assumption, in order to store the different accounting periods in a clump so that one can be found, given another.
If you want multiple books that are unrelated to each other, use multiple sessions.
The session now calls QofBackendProvider->check_data_type to check that the incoming path contains data that the backend provider can open. The backend provider should also check if it can contact it's storage media (disk, network, server, etc.) and abort if it can't. Malformed file URL's would be handled the same way.
#define QOF_STDOUT "file:" |
Allow session data to be printed to stdout.
book_id can't be NULL and we do need to have an access_method, so use one to solve the other.
To print a session to stdout, use qof_session_begin. Example:
qof_session_begin(session,QOF_STDOUT,TRUE,FALSE);
When you call qof_session_save(session, NULL), the output will appear on stdout and can be piped or redirected to other processes.
Currently, only the QSF backend supports writing to stdout, other backends may return a QofBackendError.
Definition at line 386 of file qofsession.h.
typedef void(* QofPercentageFunc)(const gchar *message, gdouble percent) |
The qof_session_load() method causes the QofBook to be made ready to to use with this URL/datastore. When the URL points at a file, then this routine would load the data from the file. With remote backends, e.g. network or SQL, this would load only enough data to make the book actually usable; it would not cause *all* of the data to be loaded.
XXX the current design tries to accomodate multiple calls to 'load' for each session, each time wiping out the old books; this seems wrong to me, and should be restricted to allow only one load per session.
Definition at line 168 of file qofsession.h.
gboolean qof_entity_copy_coll | ( | QofSession * | new_session, | |
QofCollection * | entity_coll | |||
) |
Copy a QofCollection of entities.
The QofBook in the new_session must not contain any entities with the same GUID as any entities in the collection - there is no support for handling collisions - instead, use Merge: Merging QofBook structures
new_session | - the target session | |
entity_coll | - a QofCollection of any QofIdType. |
Definition at line 710 of file qofsession.c.
00712 { 00713 QofEntityCopyData qecd; 00714 00715 g_return_val_if_fail (new_session, FALSE); 00716 if (!entity_coll) 00717 { 00718 return FALSE; 00719 } 00720 qof_event_suspend (); 00721 qecd.param_list = NULL; 00722 qecd.new_session = new_session; 00723 qof_book_set_partial (qof_session_get_book (qecd.new_session)); 00724 qof_collection_foreach (entity_coll, qof_entity_coll_foreach, &qecd); 00725 qof_class_param_foreach (qof_collection_get_type (entity_coll), 00726 qof_entity_param_cb, &qecd); 00727 qof_collection_foreach (entity_coll, qof_entity_coll_copy, &qecd); 00728 if (qecd.param_list != NULL) 00729 { 00730 g_slist_free (qecd.param_list); 00731 } 00732 qof_event_resume (); 00733 return TRUE; 00734 }
gboolean qof_entity_copy_coll_r | ( | QofSession * | new_session, | |
QofCollection * | coll | |||
) |
Recursively copy a collection of entities to a session.
Objects can be defined solely in terms of QOF data types or as a mix of data types and other objects, which may in turn include other objects. These references can be copied recursively down to the third level. See QofEntityReference.
coll | A QofCollection of entities that may or may not have references. | |
new_session | The QofSession to receive the copied entities. |
Definition at line 884 of file qofsession.c.
00885 { 00886 struct recurse_s store; 00887 gboolean success; 00888 00889 if ((!new_session) || (!coll)) 00890 { 00891 return FALSE; 00892 } 00893 store.session = new_session; 00894 success = TRUE; 00895 store.success = success; 00896 store.ent_list = NULL; 00897 store.ref_list = 00898 qof_class_get_referenceList (qof_collection_get_type (coll)); 00899 success = qof_entity_copy_coll (new_session, coll); 00900 if (success) 00901 { 00902 qof_collection_foreach (coll, recurse_ent_cb, &store); 00903 } 00904 return success; 00905 }
gboolean qof_entity_copy_list | ( | QofSession * | new_session, | |
GList * | entity_list | |||
) |
Copy a GList of entities to another session.
The QofBook in the new_session must not contain any entities with the same GUID as any of the source entities - there is no support for handling collisions, instead use Merge: Merging QofBook structures
Note that the GList (e.g. from qof_sql_query_run) can contain QofEntity pointers of any QofIdType, in any sequence. As long as all members of the list are QofEntity*, and all GUID's are unique, the list can be copied.
new_session | - the target session | |
entity_list | - a GList of QofEntity pointers of any type(s). |
Definition at line 688 of file qofsession.c.
00689 { 00690 QofEntityCopyData *qecd; 00691 00692 if (!new_session || !entity_list) 00693 return FALSE; 00694 ENTER (" list=%d", g_list_length (entity_list)); 00695 qecd = g_new0 (QofEntityCopyData, 1); 00696 qof_event_suspend (); 00697 qecd->param_list = NULL; 00698 qecd->new_session = new_session; 00699 qof_book_set_partial (qof_session_get_book (new_session)); 00700 g_list_foreach (entity_list, qof_entity_list_foreach, qecd); 00701 qof_event_resume (); 00702 if (qecd->error) 00703 PWARN (" some/all entities in the list could not be copied."); 00704 g_free (qecd); 00705 LEAVE (" "); 00706 return TRUE; 00707 }
gboolean qof_entity_copy_one_r | ( | QofSession * | new_session, | |
QofEntity * | ent | |||
) |
Recursively copy a single entity to a new session.
Copy the single entity and all referenced entities to the second level.
Only entities that are directly referenced by the top level entity are copied.
This is a deep copy - all parameters of all referenced entities are copied. If the top level entity has no references, this is identical to qof_entity_copy_to_session.
ent | A single entity that may or may not have references. | |
new_session | The QofSession to receive the copied entities. |
Definition at line 908 of file qofsession.c.
00909 { 00910 struct recurse_s store; 00911 QofCollection *coll; 00912 gboolean success; 00913 00914 if ((!new_session) || (!ent)) 00915 { 00916 return FALSE; 00917 } 00918 store.session = new_session; 00919 success = TRUE; 00920 store.success = success; 00921 store.ref_list = qof_class_get_referenceList (ent->e_type); 00922 success = qof_entity_copy_to_session (new_session, ent); 00923 if (success == TRUE) 00924 { 00925 coll = 00926 qof_book_get_collection (qof_session_get_book (new_session), 00927 ent->e_type); 00928 if (coll) 00929 { 00930 qof_collection_foreach (coll, recurse_ent_cb, &store); 00931 } 00932 } 00933 return success; 00934 }
gboolean qof_entity_copy_to_session | ( | QofSession * | new_session, | |
QofEntity * | original | |||
) |
Copy a single QofEntity to another session.
Checks first that no entity in the session book contains the GUID of the source entity.
new_session | - the target session | |
original | - the QofEntity* to copy |
Definition at line 656 of file qofsession.c.
00657 { 00658 QofEntityCopyData qecd; 00659 QofInstance *inst; 00660 QofBook *book; 00661 00662 if (!new_session || !original) 00663 return FALSE; 00664 if (qof_entity_guid_match (new_session, original)) 00665 return FALSE; 00666 if (!qof_object_compliance (original->e_type, TRUE)) 00667 return FALSE; 00668 qof_event_suspend (); 00669 qecd.param_list = NULL; 00670 book = qof_session_get_book (new_session); 00671 qecd.new_session = new_session; 00672 qof_book_set_partial (book); 00673 inst = 00674 (QofInstance *) qof_object_new_instance (original->e_type, book); 00675 qecd.to = &inst->entity; 00676 qecd.from = original; 00677 qof_entity_set_guid (qecd.to, qof_entity_get_guid (original)); 00678 qof_class_param_foreach (original->e_type, qof_entity_param_cb, &qecd); 00679 if (g_slist_length (qecd.param_list) == 0) 00680 return FALSE; 00681 g_slist_foreach (qecd.param_list, qof_entity_foreach_copy, &qecd); 00682 g_slist_free (qecd.param_list); 00683 qof_event_resume (); 00684 return TRUE; 00685 }
void qof_session_add_book | ( | QofSession * | session, | |
QofBook * | book | |||
) |
The qof_session_add_book() allows additional books to be added to a session. XXX Under construction, clarify the following when done: XXX There must already be an open book in the session already!? XXX Only one open book at a time per session is allowed!? XXX each book gets its own unique backend ???
Definition at line 148 of file qofsession.c.
00149 { 00150 GList *node; 00151 if (!session) 00152 return; 00153 00154 ENTER (" sess=%p book=%p", session, addbook); 00155 00156 /* See if this book is already there ... */ 00157 for (node = session->books; node; node = node->next) 00158 { 00159 QofBook *book = node->data; 00160 if (addbook == book) 00161 return; 00162 } 00163 00164 if ('y' == addbook->book_open) 00165 { 00166 /* hack alert -- someone should free all the books in the list, 00167 * but it should probably not be us ... since the books backends 00168 * should be shutdown first, etc */ 00169 /* XXX this should probably be an error XXX */ 00170 g_list_free (session->books); 00171 session->books = g_list_append (NULL, addbook); 00172 } 00173 else 00174 { 00175 /* XXX Need to tell the backend to add a book as well */ 00176 session->books = g_list_append (session->books, addbook); 00177 } 00178 00179 qof_book_set_backend (addbook, session->backend); 00180 LEAVE (" "); 00181 }
void qof_session_add_close_hook | ( | GFunc | fn, | |
gpointer | data | |||
) |
Register a function to be called just before a session is closed.
fn | The function to be called. The function definition must be func(gpointer session, gpointer user_data); | |
data | The data to be passed to the function. |
Definition at line 69 of file qofsession.c.
00070 { 00071 GHook *hook; 00072 00073 if (session_closed_hooks == NULL) 00074 { 00075 session_closed_hooks = malloc (sizeof (GHookList)); /* LEAKED */ 00076 g_hook_list_init (session_closed_hooks, sizeof (GHook)); 00077 } 00078 00079 hook = g_hook_alloc (session_closed_hooks); 00080 if (!hook) 00081 return; 00082 00083 hook->func = (GHookFunc) fn; 00084 hook->data = data; 00085 g_hook_append (session_closed_hooks, hook); 00086 }
void qof_session_begin | ( | QofSession * | session, | |
const gchar * | book_id, | |||
gboolean | ignore_lock, | |||
gboolean | create_if_nonexistent | |||
) |
The qof_session_begin () method begins a new session. It takes as an argument the book id. The book id must be a string in the form of a URI/URL. The access method specified depends on the loaded backends. In the absence of a customised backend, only QSF XML would be accepted). Paths may be relative or absolute. If the path is relative; that is, if the argument is "file:somefile.xml" then the current working directory is assumed. Customised backends can choose to search other, application-specific, directories as well.
The 'ignore_lock' argument, if set to TRUE, will cause this routine to ignore any global-datastore locks (e.g. file locks) that it finds. If set to FALSE, then file/database-global locks will be tested and obeyed.
If the datastore exists, can be reached (e.g over the net), connected to, opened and read, and a lock can be obtained then a lock will be obtained. Note that multi-user datastores (e.g. the SQL backend) typically will not need to get a global lock, and thus, the user will not be locked out. That's the whole point of 'multi-user'.
If the file/database doesn't exist, and the create_if_nonexistent flag is set to TRUE, then the database is created.
If an error occurs, it will be pushed onto the session error stack, and that is where it should be examined.
Definition at line 1057 of file qofsession.c.
01059 { 01060 gchar *p, *access_method; 01061 01062 if (!session) 01063 return; 01064 01065 ENTER (" sess=%p ignore_lock=%d, book-id=%s", 01066 session, ignore_lock, book_id ? book_id : "(null)"); 01067 01068 /* Clear the error condition of previous errors */ 01069 qof_error_clear (session); 01070 01071 /* Check to see if this session is already open */ 01072 if (session->book_id) 01073 { 01074 qof_error_set (session, qof_error_register 01075 (_("This book appears to be open already."), FALSE)); 01076 LEAVE (" push error book is already open "); 01077 return; 01078 } 01079 01080 if (!book_id) 01081 { 01082 LEAVE (" using stdout"); 01083 return; 01084 } 01085 01086 /* Store the session URL */ 01087 session->book_id = g_strdup (book_id); 01088 01089 /* destroy the old backend */ 01090 qof_session_destroy_backend (session); 01091 01092 /* Look for something of the form of "file:/", "http://" or 01093 * "postgres://". Everything before the colon is the access 01094 * method. Load the first backend found for that access method. 01095 */ 01096 p = strchr (book_id, ':'); 01097 if (p) 01098 { 01099 access_method = g_strdup (book_id); 01100 p = strchr (access_method, ':'); 01101 *p = 0; 01102 qof_session_load_backend (session, access_method); 01103 g_free (access_method); 01104 } 01105 else 01106 { 01107 /* If no colon found, assume it must be a file-path */ 01108 qof_session_load_backend (session, "file"); 01109 } 01110 01111 /* No backend was found. That's bad. */ 01112 if (NULL == session->backend) 01113 { 01114 gchar * msg; 01115 01116 msg = g_strdup_printf (_("Unable to locate a " 01117 "suitable backend for '%s' - please check " 01118 "you have specified an access method " 01119 "like file: or sqlite:"), book_id); 01120 qof_error_set (session, qof_error_register 01121 (msg, FALSE)); 01122 DEBUG (" msg=%s", msg); 01123 LEAVE (" BAD: no backend: sess=%p book-id=%s", 01124 session, book_id ? book_id : "(null)"); 01125 g_free (msg); 01126 return; 01127 } 01128 01129 /* If there's a begin method, call that. */ 01130 if (session->backend->session_begin) 01131 { 01132 (session->backend->session_begin) (session->backend, session, 01133 session->book_id, ignore_lock, create_if_nonexistent); 01134 PINFO (" Done running session_begin on backend"); 01135 if (qof_error_check(session) != QOF_SUCCESS) 01136 { 01137 g_free (session->book_id); 01138 session->book_id = NULL; 01139 LEAVE (" backend error "); 01140 return; 01141 } 01142 } 01143 qof_error_clear (session); 01144 LEAVE (" sess=%p book-id=%s", session, book_id ? book_id : "(null)"); 01145 }
void qof_session_call_close_hooks | ( | QofSession * | session | ) |
Call all registered session close hooks, informing them that the specified session is about to be closed.
session | A pointer to the session being closed. |
Definition at line 89 of file qofsession.c.
00090 { 00091 GHook *hook; 00092 GFunc fn; 00093 00094 if (session_closed_hooks == NULL) 00095 return; 00096 00097 hook = g_hook_first_valid (session_closed_hooks, FALSE); 00098 while (hook) 00099 { 00100 fn = (GFunc) hook->func; 00101 fn (session, hook->data); 00102 hook = g_hook_next_valid (session_closed_hooks, hook, FALSE); 00103 } 00104 }
void qof_session_end | ( | QofSession * | session | ) |
The qof_session_end() method will release the session lock. For the file backend, it will *not* save the data to a file. Thus, this method acts as an "abort" or "rollback" primitive. However, for other backends, such as the sql backend, the data would have been written out before this, and so this routines wouldn't roll-back anything; it would just shut the connection.
Definition at line 1399 of file qofsession.c.
01400 { 01401 if (!session) 01402 return; 01403 01404 ENTER (" sess=%p book_id=%s", session, session->book_id 01405 ? session->book_id : "(null)"); 01406 01407 /* close down the backend first */ 01408 if (session->backend && session->backend->session_end) 01409 { 01410 (session->backend->session_end) (session->backend); 01411 } 01412 01413 qof_error_clear (session); 01414 01415 g_free (session->book_id); 01416 session->book_id = NULL; 01417 01418 LEAVE (" sess=%p book_id=%s", session, session->book_id 01419 ? session->book_id : "(null)"); 01420 }
gboolean qof_session_events_pending | ( | QofSession * | session | ) |
The qof_session_events_pending() method will return TRUE if the backend has pending events which must be processed to bring the engine up to date with the backend.
Definition at line 1492 of file qofsession.c.
01493 { 01494 if (!session) 01495 return FALSE; 01496 if (!session->backend) 01497 return FALSE; 01498 if (!session->backend->events_pending) 01499 return FALSE; 01500 01501 return session->backend->events_pending (session->backend); 01502 }
const gchar* qof_session_get_file_path | ( | QofSession * | session | ) |
The qof_session_get_file_path() routine returns the fully-qualified file path for the session. That is, if a relative or partial filename was for the session, then it had to have been fully resolved to open the session. This routine returns the result of this resolution. The path is always guaranteed to reside in the local file system, even if the session itself was opened as a URL. (currently, the filepath is derived from the url by substituting commas for slashes).
The qof_session_get_url() routine returns the url that was opened. URL's for local files take the form of file:/some/where/some/file.gml
Definition at line 192 of file qofsession.c.
00193 { 00194 if (!session) 00195 return NULL; 00196 if (!session->backend) 00197 return NULL; 00198 return session->backend->fullpath; 00199 }
gboolean qof_session_not_saved | ( | QofSession * | session | ) |
The qof_session_not_saved() subroutine will return TRUE if any data in the session hasn't been saved to long-term storage.
gboolean qof_session_process_events | ( | QofSession * | session | ) |
The qof_session_process_events() method will process any events indicated by the qof_session_events_pending() method. It returns TRUE if the engine was modified while engine events were suspended.
Definition at line 1505 of file qofsession.c.
01506 { 01507 if (!session) 01508 return FALSE; 01509 if (!session->backend) 01510 return FALSE; 01511 if (!session->backend->process_events) 01512 return FALSE; 01513 01514 return session->backend->process_events (session->backend); 01515 }
void qof_session_save | ( | QofSession * | session, | |
QofPercentageFunc | percentage_func | |||
) |
The qof_session_save() method will commit all changes that have been made to the session. For the file backend, this is nothing more than a write to the file of the current AccountGroup & etc. For the SQL backend, this is typically a no-op (since all data has already been written out to the database.
Definition at line 1245 of file qofsession.c.
01247 { 01248 GList *node; 01249 QofBackend *be; 01250 gboolean partial, change_backend; 01251 QofBackendProvider *prov; 01252 GSList *p; 01253 QofBook *book, *abook; 01254 gint num; 01255 gchar *msg, *book_id; 01256 01257 if (!session) 01258 return; 01259 ENTER (" sess=%p book_id=%s", 01260 session, session->book_id ? session->book_id : "(null)"); 01261 /* Partial book handling. */ 01262 book = qof_session_get_book (session); 01263 partial = 01264 (gboolean) 01265 GPOINTER_TO_INT (qof_book_get_data (book, PARTIAL_QOFBOOK)); 01266 change_backend = FALSE; 01267 msg = g_strdup_printf (" "); 01268 book_id = g_strdup (session->book_id); 01269 if (partial == TRUE) 01270 { 01271 if (session->backend && session->backend->provider) 01272 { 01273 prov = session->backend->provider; 01274 if (TRUE == prov->partial_book_supported) 01275 { 01276 /* if current backend supports partial, leave alone. */ 01277 change_backend = FALSE; 01278 } 01279 else 01280 { 01281 change_backend = TRUE; 01282 } 01283 } 01284 /* If provider is undefined, assume partial not supported. */ 01285 else 01286 { 01287 change_backend = TRUE; 01288 } 01289 } 01290 if (change_backend == TRUE) 01291 { 01292 qof_session_destroy_backend (session); 01293 if (NULL == provider_list) 01294 { 01295 for (num = 0; backend_list[num].filename != NULL; num++) 01296 { 01297 qof_load_backend_library (backend_list[num].libdir, 01298 backend_list[num].filename, 01299 backend_list[num].init_fcn); 01300 } 01301 } 01302 p = g_slist_copy (provider_list); 01303 while (p != NULL) 01304 { 01305 prov = p->data; 01306 if (TRUE == prov->partial_book_supported) 01307 { 01309 /* if((TRUE == prov->partial_book_supported) && 01310 (0 == strcasecmp (access_method, prov->access_method))) 01311 { */ 01312 if (NULL == prov->backend_new) 01313 continue; 01314 /* Use the providers creation callback */ 01315 session->backend = (*(prov->backend_new)) (); 01316 session->backend->provider = prov; 01317 if (session->backend->session_begin) 01318 { 01319 /* Call begin - backend has been changed, 01320 so make sure a file can be written, 01321 use ignore_lock and create_if_nonexistent */ 01322 g_free (session->book_id); 01323 session->book_id = NULL; 01324 (session->backend->session_begin) (session->backend, 01325 session, book_id, TRUE, TRUE); 01326 PINFO 01327 (" Done running session_begin on changed backend"); 01328 if (qof_error_check (session) != QOF_SUCCESS) 01329 { 01330 g_free (session->book_id); 01331 session->book_id = NULL; 01332 LEAVE (" changed backend error"); 01333 return; 01334 } 01335 } 01336 /* Tell the books about the backend that they'll be using. */ 01337 for (node = session->books; node; node = node->next) 01338 { 01339 book = node->data; 01340 qof_book_set_backend (book, session->backend); 01341 } 01342 p = NULL; 01343 } 01344 if (p) 01345 { 01346 p = p->next; 01347 } 01348 } 01349 if (!session->backend) 01350 { 01351 msg = g_strdup_printf (" failed to load backend"); 01352 qof_error_set (session, qof_error_register 01353 (_("Failed to load backend, no suitable handler."), 01354 FALSE)); 01355 return; 01356 } 01357 } 01358 /* If there is a backend, and the backend is reachable 01359 * (i.e. we can communicate with it), then synchronize with 01360 * the backend. If we cannot contact the backend (e.g. 01361 * because we've gone offline, the network has crashed, etc.) 01362 * then give the user the option to save to the local disk. 01363 * 01364 * hack alert -- FIXME -- XXX the code below no longer 01365 * does what the words above say. This needs fixing. 01366 */ 01367 be = session->backend; 01368 if (be) 01369 { 01370 for (node = session->books; node; node = node->next) 01371 { 01372 abook = node->data; 01373 /* if invoked as SaveAs(), then backend not yet set */ 01374 qof_book_set_backend (abook, be); 01375 be->percentage = percentage_func; 01376 if (be->sync) 01377 (be->sync) (be, abook); 01378 } 01379 /* If we got to here, then the backend saved everything 01380 * just fine, and we are done. So return. */ 01381 /* Return the book_id to previous value. */ 01382 qof_error_clear (session); 01383 LEAVE (" Success"); 01384 return; 01385 } 01386 else 01387 { 01388 msg = g_strdup_printf (" failed to load backend"); 01389 qof_error_set (session, qof_error_register 01390 (_("Failed to load backend, no suitable handler."), 01391 FALSE)); 01392 } 01393 LEAVE (" error -- No backend!"); 01394 }
gboolean qof_session_save_may_clobber_data | ( | QofSession * | session | ) |
Allows the backend to warn the user if a dataset already exists.
Definition at line 1232 of file qofsession.c.
01233 { 01234 if (!session) 01235 return FALSE; 01236 if (!session->backend) 01237 return FALSE; 01238 if (!session->backend->save_may_clobber_data) 01239 return FALSE; 01240 01241 return (*(session->backend->save_may_clobber_data)) (session->backend); 01242 }
void qof_session_swap_data | ( | QofSession * | session_1, | |
QofSession * | session_2 | |||
) |
The qof_session_swap_data () method swaps the book of the two given sessions. It is useful for 'Save As' type functionality.
Definition at line 1458 of file qofsession.c.
01459 { 01460 GList *books_1, *books_2, *node; 01461 01462 if (session_1 == session_2) 01463 return; 01464 if (!session_1 || !session_2) 01465 return; 01466 01467 ENTER (" sess1=%p sess2=%p", session_1, session_2); 01468 01469 books_1 = session_1->books; 01470 books_2 = session_2->books; 01471 01472 session_1->books = books_2; 01473 session_2->books = books_1; 01474 01475 for (node = books_1; node; node = node->next) 01476 { 01477 QofBook *book_1 = node->data; 01478 qof_book_set_backend (book_1, session_2->backend); 01479 } 01480 for (node = books_2; node; node = node->next) 01481 { 01482 QofBook *book_2 = node->data; 01483 qof_book_set_backend (book_2, session_1->backend); 01484 } 01485 01486 LEAVE (" "); 01487 }