zotero/chrome/chromeFiles/content/scholar/xpcom/data_access.js

3293 lines
77 KiB
JavaScript
Raw Normal View History

/*
* Constructor for Item object
*
* Generally should be called through Scholar.Items rather than directly
*/
Scholar.Item = function(){
this._init();
// Accept itemTypeID in constructor
if (arguments.length){
this.setType(arguments[0]);
}
}
Scholar.Item.prototype._init = function(){
//
// Public members for access by public methods -- do not access directly
//
this._data = new Array();
this._creators = new Scholar.Hash();
this._itemData = new Array();
this._creatorsLoaded = false;
this._itemDataLoaded = false;
this._changed = new Scholar.Hash();
this._changedCreators = new Scholar.Hash();
this._changedItemData = new Scholar.Hash();
}
//////////////////////////////////////////////////////////////////////////////
//
// Public Scholar.Item methods
//
//////////////////////////////////////////////////////////////////////////////
/*
* Check if the specified field is a primary field from the items table
*/
Scholar.Item.prototype.isPrimaryField = function(field){
// Create primaryFields hash array if not yet created
if (!Scholar.Item.primaryFields){
Scholar.Item.primaryFields = Scholar.DB.getColumnHash('items');
Scholar.Item.primaryFields['firstCreator'] = true;
2006-06-25 05:43:00 +00:00
Scholar.Item.primaryFields['numNotes'] = true;
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
Scholar.Item.primaryFields['numFiles'] = true;
}
return !!Scholar.Item.primaryFields[field];
}
Scholar.Item.editableFields = {
title: true
};
/*
* Check if the specified primary field can be changed with setField()
*/
Scholar.Item.prototype.isEditableField = function(field){
return !!Scholar.Item.editableFields[field];
}
/*
* Build object from database
*/
Scholar.Item.prototype.loadFromID = function(id){
2006-06-25 05:43:00 +00:00
// Should be the same as query in Scholar.Items.loadFromID, just
// without itemID clause
var sql = 'SELECT I.*, lastName || '
+ 'CASE ((SELECT COUNT(*) FROM itemCreators WHERE itemID=' + id + ')>1) '
2006-06-25 05:43:00 +00:00
+ "WHEN 0 THEN '' ELSE ' et al.' END AS firstCreator, "
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
+ "(SELECT COUNT(*) FROM itemNotes WHERE sourceItemID=I.itemID) AS numNotes, "
+ "(SELECT COUNT(*) FROM itemFiles WHERE sourceItemID=I.itemID) AS numFiles "
+ 'FROM items I '
+ 'LEFT JOIN itemCreators IC ON (I.itemID=IC.itemID) '
+ 'LEFT JOIN creators C ON (IC.creatorID=C.creatorID) '
+ 'WHERE itemID=' + id
+ ' AND (IC.orderIndex=0 OR IC.orderIndex IS NULL)'; // first creator
var row = Scholar.DB.rowQuery(sql);
this.loadFromRow(row);
}
/*
* Populate basic item data from a database row
*/
Scholar.Item.prototype.loadFromRow = function(row){
this._init();
for (col in row){
// Only accept primary field data through loadFromRow()
if (this.isPrimaryField(col)){
this._data[col] = row[col];
}
else {
Scholar.debug(col + ' is not a valid primary field');
}
}
return true;
}
/*
* Check if any data fields have changed since last save
*/
Scholar.Item.prototype.hasChanged = function(){
return (this._changed.length || this._changedCreators.length ||
this._changedItemData.length);
}
Scholar.Item.prototype.getID = function(){
return this._data['itemID'] ? this._data['itemID'] : false;
}
Scholar.Item.prototype.getType = function(){
return this._data['itemTypeID'] ? this._data['itemTypeID'] : false;
}
/*
* Set or change the item's type
*/
Scholar.Item.prototype.setType = function(itemTypeID){
if (itemTypeID==this.getType()){
return true;
}
// If existing type, clear fields from old type that aren't in new one
if (this.getType()){
var sql = 'SELECT fieldID FROM itemTypeFields '
+ 'WHERE itemTypeID=' + this.getType() + ' AND fieldID NOT IN '
+ '(SELECT fieldID FROM itemTypeFields WHERE itemTypeID='
+ itemTypeID + ')';
var obsoleteFields = Scholar.DB.columnQuery(sql);
if (obsoleteFields){
for (var i=0; i<obsoleteFields.length; i++){
this.setField(obsoleteFields[i],false);
}
}
}
this._data['itemTypeID'] = itemTypeID;
this._changed.set('itemTypeID');
return true;
}
/**
* Return an array of collectionIDs for all collections the item belongs to
**/
Scholar.Item.prototype.getCollections = function(){
return Scholar.DB.columnQuery("SELECT collectionID FROM collectionItems "
+ "WHERE itemID=" + this.getID());
}
/**
* Determine whether the item belongs to a given collectionID
**/
Scholar.Item.prototype.inCollection = function(collectionID){
return !!parseInt(Scholar.DB.valueQuery("SELECT COUNT(*) collectionID "
+ "FROM collectionItems WHERE collectionID=" + collectionID + " AND "
+ "itemID=" + this.getID()));
}
/*
* Returns the number of creators for this item
*/
Scholar.Item.prototype.numCreators = function(){
if (this.getID() && !this._creatorsLoaded){
this._loadCreators();
}
return this._creators.length;
}
/*
* Returns an array of the creator data at the given position, or false if none
*
* Note: Creator data array is returned by reference
*/
Scholar.Item.prototype.getCreator = function(pos){
if (this.getID() && !this._creatorsLoaded){
this._loadCreators();
}
if (!this._creators.items[pos]){
return false;
}
return this._creators.items[pos];
}
/*
* Returns a multidimensional array of creators, or an empty array if none
*
* Note: Creator data array is returned by reference
*/
Scholar.Item.prototype.getCreators = function(){
var creators = [];
for (var i=0, len=this.numCreators(); i<len; i++){
creators.push(this.getCreator(i));
}
return creators;
}
/*
* Set or update the creator at the specified position
*/
Scholar.Item.prototype.setCreator = function(orderIndex, firstName, lastName, creatorTypeID){
if (this.getID() && !this._creatorsLoaded){
this._loadCreators();
}
if (!firstName){
firstName = '';
}
if (!lastName){
lastName = '';
}
// If creator at this position hasn't changed, cancel
if (this._creators.has(orderIndex) &&
this._creators.get(orderIndex)['firstName']==firstName &&
this._creators.get(orderIndex)['lastName']==lastName &&
this._creators.get(orderIndex)['creatorTypeID']==creatorTypeID){
return false;
}
if (!creatorTypeID){
creatorTypeID = 1;
}
var creator = new Array();
creator['firstName'] = firstName;
creator['lastName'] = lastName;
creator['creatorTypeID'] = creatorTypeID;
this._creators.set(orderIndex, creator);
this._changedCreators.set(orderIndex);
return true;
}
/*
* Remove a creator and shift others down
*/
Scholar.Item.prototype.removeCreator = function(orderIndex){
if (this.getID() && !this._creatorsLoaded){
this._loadCreators();
}
if (!this._creators.has(orderIndex)){
throw ('No creator exists at position ' + orderIndex);
}
this._creators.remove(orderIndex);
// Go to length+1 so we clear the last one
for (var i=orderIndex, max=this._creators.length+1; i<max; i++){
var next =
this._creators.items[i+1] ? this._creators.items[i+1] : false;
this._creators.set(i, next);
this._changedCreators.set(i);
}
return true;
}
Scholar.Item.prototype.creatorExists = function(firstName, lastName, creatorTypeID, skipIndex){
for (var j=0, len=this.numCreators(); j<len; j++){
if (typeof skipIndex!='undefined' && skipIndex==j){
continue;
}
var creator2 = this.getCreator(j);
if (firstName==creator2['firstName'] &&
lastName==creator2['lastName'] &&
creatorTypeID==creator2['creatorTypeID']){
return true;
}
}
return false;
}
/*
* Retrieves (and loads from DB, if necessary) an itemData field value
*
* Field can be passed as fieldID or fieldName
*/
Scholar.Item.prototype.getField = function(field){
//Scholar.debug('Requesting field ' + field + ' for item ' + this.getID(), 4);
if (this.isPrimaryField(field)){
return this._data[field] ? this._data[field] : '';
}
else {
if (this.getID() && !this._itemDataLoaded){
this._loadItemData();
}
var fieldID = Scholar.ItemFields.getID(field);
return this._itemData[fieldID] ? this._itemData[fieldID] : '';
}
}
/*
* Set a field value, loading existing itemData first if necessary
*
* Field can be passed as fieldID or fieldName
*/
Scholar.Item.prototype.setField = function(field, value, loadIn){
// Primary field
if (this.isPrimaryField(field)){
if (!this.isEditableField(field)){
throw ('Primary field ' + field + ' cannot be changed through ' +
'setField');
}
if (this._data[field] && this._data[field]==value){
return false;
}
this._data[field] = value;
this._changed.set(field);
return true;
}
// Type-specific field
else {
if (!this.getType()){
throw ('Item type must be set before setting field data.');
}
// If existing item, load field data first unless we're already in
// the middle of a load
if (this.getID() && !loadIn && !this._itemDataLoaded){
this._loadItemData();
}
var fieldID = Scholar.ItemFields.getID(field);
if (!fieldID){
throw (field + ' is not a valid itemData field.');
}
if (!Scholar.ItemFields.isValidForType(fieldID, this.getType())){
throw (field + ' is not a valid field for this type.');
}
// If existing value, make sure it's actually changing
if ((!this._itemData[fieldID] && !value) ||
(this._itemData[fieldID] && this._itemData[fieldID]==value)){
return false;
}
this._itemData[fieldID] = value;
if (!loadIn){
this._changedItemData.set(fieldID);
}
return true;
}
}
/*
* Save changes back to database
*
* Note: Does not call notify() if transaction is in progress
*
* Returns true on item update or itemID of new item
*/
Scholar.Item.prototype.save = function(){
if (!this.hasChanged()){
Scholar.debug('Item ' + this.getID() + ' has not changed', 4);
return !!this.getID();
}
//
// Existing item, update
//
if (this.getID()){
Scholar.debug('Updating database with new item data', 4);
var itemID = this.getID();
try {
Scholar.DB.beginTransaction();
// Begin history transaction
Scholar.History.begin('modify-item', this.getID());
//
// Primary fields
//
Scholar.History.modify('items', 'itemID', this.getID());
var sql = "UPDATE items SET ";
var sql2;
var sqlValues = [];
if (this._changed.has('itemTypeID')){
sql += "itemTypeID=?, ";
sqlValues.push({'int':this.getField('itemTypeID')});
}
if (this._changed.has('title')){
sql += "title=?, ";
sqlValues.push({'string':this.getField('title')});
}
// Always update modified time
sql += "dateModified=CURRENT_TIMESTAMP ";
sql += "WHERE itemID=?";
sqlValues.push({'int':this.getID()});
Scholar.DB.query(sql, sqlValues);
//
// Creators
//
if (this._changedCreators.length){
for (var i=0, len=this.numCreators(); i<len; i++){
var creator = this.getCreator(i);
if (this.creatorExists(creator['firstName'],
creator['lastName'], creator['creatorTypeID'], i)){
throw('Cannot add duplicate creator/creatorType '
+ 'to item ' + this.getID());
}
}
for (orderIndex in this._changedCreators.items){
Scholar.debug('Creator ' + orderIndex + ' has changed', 4);
var creator = this.getCreator(orderIndex);
// Delete at position
Scholar.History.remove('itemCreators', 'itemID-orderIndex',
[this.getID(), orderIndex]);
sql2 = 'DELETE FROM itemCreators'
+ ' WHERE itemID=' + this.getID()
+ ' AND orderIndex=' + orderIndex;
Scholar.DB.query(sql2);
// If empty, move on
if (!creator['firstName'] && !creator['lastName']){
continue;
}
// See if this is an existing creator
2006-03-21 15:19:11 +00:00
var creatorID = Scholar.Creators.getID(
creator['firstName'],
creator['lastName']
);
// If not, add it
if (!creatorID){
2006-03-21 15:19:11 +00:00
creatorID = Scholar.Creators.add(
creator['firstName'],
creator['lastName']
);
Scholar.History.add('creators', 'creatorID', creatorID);
}
sql2 = 'SELECT COUNT(*) FROM itemCreators'
+ ' WHERE itemID=' + this.getID()
+ ' AND creatorID=' + creatorID
+ ' AND creatorTypeID=' + creator['creatorTypeID'];
// If this creator and creatorType exists elsewhere, move it
if (Scholar.DB.valueQuery(sql2)){
Scholar.History.modify('itemCreators',
'itemID-creatorID-creatorTypeID',
[this.getID(), creatorID, creator['creatorTypeID']]);
sql = 'UPDATE itemCreators SET orderIndex=? '
+ "WHERE itemID=? AND creatorID=? AND "
+ "creatorTypeID=?";
sqlValues = [
{'int':orderIndex},
{'int':this.getID()},
{'int':creatorID},
{'int':creator['creatorTypeID']}
];
Scholar.DB.query(sql, sqlValues);
}
// Otherwise insert
else {
sql = "INSERT INTO itemCreators VALUES (?,?,?,?)";
sqlValues = [
{'int':itemID},
{'int':creatorID},
{'int':creator['creatorTypeID']},
{'int':orderIndex}
];
Scholar.DB.query(sql, sqlValues);
Scholar.History.add('itemCreators',
'itemID-creatorID-creatorTypeID',
[this.getID(), creatorID, creator['creatorTypeID']]);
}
}
// Delete obsolete creators
var deleted;
if (deleted = Scholar.Creators.purge()){
for (var i in deleted){
// Add purged creators to history
Scholar.History.remove('creators', 'creatorID', i);
}
}
}
//
// ItemData
//
if (this._changedItemData.length){
var del = new Array();
for (fieldID in this._changedItemData.items){
if (this.getField(fieldID)){
// Oh, for an INSERT...ON DUPLICATE KEY UPDATE
sql2 = 'SELECT COUNT(*) FROM itemData '
+ 'WHERE itemID=' + this.getID()
+ ' AND fieldID=' + fieldID;
// Update
if (Scholar.DB.valueQuery(sql2)){
sqlValues = [];
Scholar.History.modify('itemData', 'itemID-fieldID',
[this.getID(), fieldID]);
sql = "UPDATE itemData SET value=?";
// Take advantage of SQLite's manifest typing
if (Scholar.ItemFields.isInteger(fieldID)){
sqlValues.push({'int':this.getField(fieldID)});
}
else {
sqlValues.push({'string':this.getField(fieldID)});
}
sql += " WHERE itemID=? AND fieldID=?";
sqlValues.push(
{'int':this.getID()},
{'int':fieldID}
);
Scholar.DB.query(sql, sqlValues);
}
// Insert
else {
Scholar.History.add('itemData', 'itemID-fieldID',
[this.getID(), fieldID]);
sql = "INSERT INTO itemData VALUES (?,?,?)";
sqlValues = [
{'int':this.getID()},
{'int':fieldID},
];
if (Scholar.ItemFields.isInteger(fieldID)){
sqlValues.push({'int':this.getField(fieldID)});
}
else {
sqlValues.push({'string':this.getField(fieldID)});
}
Scholar.DB.query(sql, sqlValues);
}
}
// If field changed and is empty, mark row for deletion
else {
del.push(fieldID);
}
}
// Delete blank fields
if (del.length){
// Add to history
for (var i in del){
Scholar.History.remove('itemData', 'itemID-fieldID',
[this.getID(), del[i]]);
}
sql = 'DELETE from itemData '
+ 'WHERE itemID=' + this.getID() + ' '
+ 'AND fieldID IN (' + del.join() + ")";
Scholar.DB.query(sql);
}
}
Scholar.History.commit();
Scholar.DB.commitTransaction();
}
catch (e){
Scholar.History.cancel();
Scholar.DB.rollbackTransaction();
throw(e);
}
}
//
// New item, insert and return id
//
else {
Scholar.debug('Saving data for new item to database');
var isNew = true;
var sqlColumns = new Array();
var sqlValues = new Array();
//
// Primary fields
//
sqlColumns.push('itemID');
var itemID = Scholar.getRandomID('items', 'itemID');
sqlValues.push(itemID);
sqlColumns.push('itemTypeID');
sqlValues.push({'int':this.getField('itemTypeID')});
if (this._changed.has('title')){
sqlColumns.push('title');
sqlValues.push({'string':this.getField('title')});
}
try {
Scholar.DB.beginTransaction();
// Begin history transaction
// No associated id yet, so we use false
Scholar.History.begin('add-item', false);
//
// Primary fields
//
var sql = "INSERT INTO items (" + sqlColumns.join() + ')'
+ ' VALUES (';
// Insert placeholders for bind parameters
for (var i=0; i<sqlValues.length; i++){
sql += '?,';
}
sql = sql.substring(0,sql.length-1) + ")";
// Save basic data to items table
Scholar.DB.query(sql, sqlValues);
this._data['itemID'] = itemID;
Scholar.History.setAssociatedID(itemID);
Scholar.History.add('items', 'itemID', itemID);
//
// ItemData
//
if (this._changedItemData.length){
for (fieldID in this._changedItemData.items){
if (!this.getField(fieldID)){
continue;
}
// TODO: update DB methods so that this can be
// implemented as a prepared statement that gets
// called multiple times
sql = "INSERT INTO itemData VALUES (?,?,?)";
sqlValues = [
{'int':itemID},
{'int':fieldID}
];
if (Scholar.ItemFields.isInteger(fieldID)){
sqlValues.push({'int':this.getField(fieldID)});
}
else {
sqlValues.push({'string':this.getField(fieldID)});
}
Scholar.DB.query(sql, sqlValues);
Scholar.History.add('itemData', 'itemID-fieldID',
[itemID, fieldID]);
}
}
//
// Creators
//
if (this._changedCreators.length){
for (orderIndex in this._changedCreators.items){
var creator = this.getCreator(orderIndex);
// If empty, skip
if (!creator['firstName'] && !creator['lastName']){
continue;
}
// See if this is an existing creator
var creatorID = Scholar.Creators.getID(
creator['firstName'],
creator['lastName']
);
// If not, add it
if (!creatorID){
creatorID = Scholar.Creators.add(
creator['firstName'],
creator['lastName']
);
Scholar.History.add('creators', 'creatorID', creatorID);
}
sql = 'INSERT INTO itemCreators VALUES ('
+ itemID + ',' + creatorID + ','
+ creator['creatorTypeID'] + ', ' + orderIndex
+ ")";
Scholar.DB.query(sql);
Scholar.History.add('itemCreators',
'itemID-creatorID-creatorTypeID',
[this.getID(), creatorID, creator['creatorTypeID']]);
}
}
Scholar.History.commit();
Scholar.DB.commitTransaction();
// Reload collection to update isEmpty,
// in case this was the first item in a collection
Scholar.Collections.reloadAll();
}
catch (e){
Scholar.History.cancel();
Scholar.DB.rollbackTransaction();
throw(e);
}
}
Scholar.Items.reload(this.getID());
2006-06-02 01:17:44 +00:00
if (isNew){
if (!Scholar.DB.transactionInProgress()){
Scholar.Notifier.trigger('add', 'item', this.getID());
}
2006-06-02 01:17:44 +00:00
return this.getID();
}
else {
if (!Scholar.DB.transactionInProgress()){
Scholar.Notifier.trigger('modify', 'item', this.getID());
}
2006-06-02 01:17:44 +00:00
return true;
}
}
Scholar.Item.prototype.updateDateModified = function(){
Scholar.DB.query("UPDATE items SET dateModified=CURRENT_TIMESTAMP "
+ "WHERE itemID=" + this.getID());
var date = Scholar.DB.valueQuery("SELECT dateModified FROM items "
+ "WHERE itemID=" + this.getID());
this._data['dateModified'] = date;
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
////////////////////////////////////////////////////////
//
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// Methods dealing with note items
//
// save() is not required for note functions
//
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
////////////////////////////////////////////////////////
Scholar.Item.prototype.incrementNoteCount = function(){
2006-06-25 05:43:00 +00:00
this._data['numNotes']++;
}
Scholar.Item.prototype.decrementNoteCount = function(){
this._data['numNotes']--;
}
/**
* Determine if an item is a note
**/
Scholar.Item.prototype.isNote = function(){
return Scholar.ItemTypes.getName(this.getType())=='note';
}
/**
* Update an item note
*
* Note: This can only be called on note items.
**/
Scholar.Item.prototype.updateNote = function(text){
if (!this.isNote()){
throw ("updateNote() can only be called on items of type 'note'");
}
if (!this.getID()){
throw ("Cannot call updateNote() on unsaved note");
}
Scholar.DB.beginTransaction();
var sql = "UPDATE itemNotes SET note=? WHERE itemID=?";
bindParams = [{string:text}, this.getID()];
var updated = Scholar.DB.query(sql, bindParams);
if (updated){
2006-06-25 05:43:00 +00:00
this.updateDateModified();
Scholar.DB.commitTransaction();
Scholar.Notifier.trigger('modify', 'item', this.getID());
2006-06-25 05:43:00 +00:00
}
else {
Scholar.DB.commitTransaction();
}
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
Scholar.Item.prototype.setSource = function(sourceItemID){
if (this.isNote()){
var type = 'note';
var Type = 'Note';
}
else if (this.isFile()){
var type = 'file';
var Type = 'file';
}
else {
throw ("setSource() can only be called on items of type 'note' or 'file'");
}
if (!this.getID()){
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
throw ("Cannot call setSource() on unsaved " + type);
}
Scholar.DB.beginTransaction();
var newItem = Scholar.Items.get(sourceItemID);
// FK check
if (sourceItemID && !newItem){
Scholar.DB.rollbackTransaction();
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
throw ("Cannot set " + type + " source to invalid item " + sourceItemID);
}
// Get previous source item id
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
var sql = "SELECT sourceItemID FROM item" + Type + "s WHERE item=" + this.getID();
var oldSourceItemID = Scholar.DB.valueQuery(sql);
if (oldSourceItemID==sourceItemID){
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
Scholar.debug(Type + " source hasn't changed", 4);
Scholar.DB.commitTransaction();
return false;
}
var oldItem = Scholar.Items.get(oldSourceItemID);
if (oldSourceItemID && !oldItem){
Scholar.debug("Old source item " + oldSourceItemID
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
+ "didn't exist in setSource()", 2);
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
var sql = "UPDATE item" + Type + "s SET sourceItemID=? WHERE itemID=?";
var bindParams = [sourceItemID ? {int:sourceItemID} : null, this.getID()];
Scholar.DB.query(sql, bindParams);
this.updateDateModified();
Scholar.DB.commitTransaction();
Scholar.Notifier.trigger('modify', 'item', this.getID());
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// Update the counts of the previous and new sources
if (oldItem){
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
switch (type){
case 'note':
oldItem.decrementNoteCount();
break;
case 'file':
oldItem.decrementFileCount();
break;
}
Scholar.Notifier.trigger('modify', 'item', oldSourceItemID);
}
if (newItem){
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
switch (type){
case 'note':
newItem.incrementNoteCount();
break;
case 'file':
newItem.incrementFileCount();
break;
}
Scholar.Notifier.trigger('modify', 'item', sourceItemID);
}
return true;
}
2006-06-16 15:18:01 +00:00
/**
* Returns number of notes in item
**/
Scholar.Item.prototype.numNotes = function(){
if (this.isNote()){
throw ("numNotes() cannot be called on items of type 'note'");
}
if (!this.getID()){
return 0;
}
2006-06-25 05:43:00 +00:00
return this._data['numNotes'];
2006-06-16 15:18:01 +00:00
}
/**
* Get the text of an item note
**/
Scholar.Item.prototype.getNote = function(){
if (!this.isNote()){
throw ("getNote() can only be called on items of type 'note'");
}
var sql = "SELECT note FROM itemNotes WHERE itemID=" + this.getID();
var note = Scholar.DB.valueQuery(sql);
return note ? note : '';
}
/**
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
* Get the itemID of the source item for a note or file
**/
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
Scholar.Item.prototype.getSource = function(){
if (this.isNote()){
var Type = 'Note';
}
else if (this.isFile()){
var Type = 'File';
}
else {
throw ("getSource() can only be called on items of type 'note' or 'file'");
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
var sql = "SELECT sourceItemID FROM item" + Type + "s WHERE itemID=" + this.getID();
return Scholar.DB.valueQuery(sql);
}
/**
* Returns an array of note itemIDs for this item
**/
Scholar.Item.prototype.getNotes = function(){
if (this.isNote()){
Scholar.debug('here');
throw ("getNotes() cannot be called on items of type 'note'");
}
if (!this.getID()){
return [];
}
var sql = "SELECT itemID FROM itemNotes NATURAL JOIN items "
+ "WHERE sourceItemID=" + this.getID() + " ORDER BY dateAdded";
return Scholar.DB.columnQuery(sql);
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
////////////////////////////////////////////////////////
//
// Methods dealing with file items
//
// save() is not required for file functions
//
///////////////////////////////////////////////////////
Scholar.Item.prototype.incrementFileCount = function(){
this._data['numFiles']++;
}
Scholar.Item.prototype.decrementFileCount = function(){
this._data['numFiles']--;
}
/**
* Determine if an item is a file
**/
Scholar.Item.prototype.isFile = function(){
return Scholar.ItemTypes.getName(this.getType())=='file';
}
/**
* Returns number of files in item
**/
Scholar.Item.prototype.numFiles = function(){
if (this.isFile()){
throw ("numFiles() cannot be called on items of type 'file'");
}
if (!this.getID()){
return 0;
}
return this._data['numFiles'];
}
/**
* Get an nsILocalFile for the file item, or false if the associated file doesn't exist
*
* Note: Always returns false for items with LINK_MODE_LINKED_URL,
* since they have no files -- use getFileURL() instead
**/
Scholar.Item.prototype.getFile = function(){
if (!this.isFile()){
throw ("getFile() can only be called on items of type 'file'");
}
var sql = "SELECT linkMode, path FROM itemFiles WHERE itemID=" + this.getID();
var row = Scholar.DB.rowQuery(sql);
if (!row){
throw ('File data not found for item ' + this.getID() + ' in getFile()');
}
// No associated files for linked URLs
if (row['linkMode']==Scholar.Files.LINK_MODE_LINKED_URL){
return false;
}
var file = Components.classes["@mozilla.org/file/local;1"].
createInstance(Components.interfaces.nsILocalFile);
var refDir = (linkMode==this.LINK_MODE_LINKED_FILE)
? Scholar.getScholarDirectory() : Scholar.getStorageDirectory();
file.setRelativeDescriptor(refDir, row['path']);
if (!file.exists()){
return false;
}
return file;
}
Scholar.Item.prototype.getFileURL = function(){
if (!this.isFile()){
throw ("getFileURL() can only be called on items of type 'file'");
}
var sql = "SELECT linkMode, path, originalPath FROM itemFiles "
+ "WHERE itemID=" + this.getID();
var row = Scholar.DB.rowQuery(sql);
if (!row){
throw ('File data not found for item ' + this.getID() + ' in getFileURL()');
}
switch (row['linkMode']){
case Scholar.Files.LINK_MODE_LINKED_URL:
return row['path'];
case Scholar.Files.LINK_MODE_IMPORTED_URL:
return row['originalPath'];
default:
throw ('getFileURL() cannot be called on files without associated URLs');
}
}
/**
* Get the link mode of a file item
*
* Possible return values specified as constants in Scholar.Files
* (e.g. Scholar.Files.LINK_MODE_LINKED_FILE)
**/
Scholar.Item.prototype.getFileLinkMode = function(){
if (!this.isFile()){
throw ("getFileLinkMode() can only be called on items of type 'file'");
}
var sql = "SELECT linkMode FROM itemFiles WHERE itemID=" + this.getID();
return Scholar.DB.valueQuery(sql);
}
/**
* Get the mime type of a file item (e.g. text/plain)
**/
Scholar.Item.prototype.getFileMimeType = function(){
if (!this.isFile()){
throw ("getFileData() can only be called on items of type 'file'");
}
var sql = "SELECT mimeType FROM itemFiles WHERE itemID=" + this.getID();
return Scholar.DB.valueQuery(sql);
}
/**
* Get the character set id of a file item
**/
Scholar.Item.prototype.getFileCharset = function(){
if (!this.isFile()){
throw ("getFileCharset() can only be called on items of type 'file'");
}
var sql = "SELECT charsetID FROM itemFiles WHERE itemID=" + this.getID();
return Scholar.DB.valueQuery(sql);
}
/**
* Returns an array of file itemIDs for this item
**/
Scholar.Item.prototype.getFiles = function(){
if (this.isFile()){
throw ("getFiles() cannot be called on items of type 'file'");
}
if (!this.getID()){
return [];
}
var sql = "SELECT itemID FROM itemFiles NATURAL JOIN items "
+ "WHERE sourceItemID=" + this.getID() + " ORDER BY dateAdded";
return Scholar.DB.columnQuery(sql);
}
//
// Methods dealing with item tags
//
// save() is not required for tag functions
//
Scholar.Item.prototype.addTag = function(tag){
if (!this.getID()){
this.save();
}
Scholar.DB.beginTransaction();
var tagID = Scholar.Tags.getID(tag);
if (!tagID){
var tagID = Scholar.Tags.add(tag);
}
var sql = "INSERT OR IGNORE INTO itemTags VALUES (?,?)";
Scholar.DB.query(sql, [this.getID(), tagID]);
Scholar.DB.commitTransaction();
Scholar.Notifier.trigger('modify', 'item', this.getID());
return tagID;
}
Scholar.Item.prototype.getTags = function(){
var sql = "SELECT tag FROM tags WHERE tagID IN "
+ "(SELECT tagID FROM itemTags WHERE itemID=" + this.getID() + ")";
return Scholar.DB.columnQuery(sql);
}
Scholar.Item.prototype.getTagIDs = function(){
var sql = "SELECT tagID FROM itemTags WHERE itemID=" + this.getID();
return Scholar.DB.columnQuery(sql);
}
Scholar.Item.prototype.removeTag = function(tagID){
if (!this.getID()){
throw ('Cannot remove tag on unsaved item');
}
Scholar.DB.beginTransaction();
var sql = "DELETE FROM itemTags WHERE itemID=? AND tagID=?";
Scholar.DB.query(sql, [this.getID(), tagID]);
Scholar.Tags.purge();
Scholar.DB.commitTransaction();
Scholar.Notifier.trigger('modify', 'item', this.getID());
}
//
// Methods dealing with See Also links
//
// save() is not required for See Also functions
//
Scholar.Item.prototype.addSeeAlso = function(itemID){
if (itemID==this.getID()){
Scholar.debug('Cannot add item as See Also of itself', 2);
return false;
}
Scholar.DB.beginTransaction();
if (!Scholar.Items.get(itemID)){
Scholar.DB.commitTransaction();
throw ("Cannot add invalid item " + itemID + " as See Also");
return false;
}
// Check both ways, using a UNION to take advantage of indexes
var sql = "SELECT (SELECT COUNT(*) FROM itemSeeAlso WHERE itemID=?1 AND "
+ "linkedItemID=?2) + (SELECT COUNT(*) FROM itemSeeAlso WHERE "
+ "linkedItemID=?1 AND itemID=?2)";
if (Scholar.DB.valueQuery(sql, [this.getID(), itemID])){
Scholar.DB.commitTransaction();
Scholar.debug("Item " + itemID + " already linked", 2);
return false;
}
var sql = "INSERT INTO itemSeeAlso VALUES (?,?)";
Scholar.DB.query(sql, [this.getID(), {int:itemID}]);
Scholar.DB.commitTransaction();
Scholar.Notifier.trigger('modify', 'item', [this.getID(), itemID]);
return true;
}
Scholar.Item.prototype.removeSeeAlso = function(itemID){
Scholar.DB.beginTransaction();
var sql = "DELETE FROM itemSeeAlso WHERE itemID=? AND linkedItemID=?";
Scholar.DB.query(sql, [this.getID(), itemID]);
var sql = "DELETE FROM itemSeeAlso WHERE itemID=? AND linkedItemID=?";
Scholar.DB.query(sql, [itemID, this.getID()]);
Scholar.DB.commitTransaction();
Scholar.Notifier.trigger('modify', 'item', [this.getID(), itemID]);
}
Scholar.Item.prototype.getSeeAlso = function(){
// Check both ways, using a UNION to take advantage of indexes
var sql ="SELECT linkedItemID FROM itemSeeAlso WHERE itemID=?1 UNION "
+ "SELECT itemID FROM itemSeeAlso WHERE linkedItemID=?1";
return Scholar.DB.columnQuery(sql, this.getID());
}
/**
* Delete item from database and clear from Scholar.Items internal array
**/
Scholar.Item.prototype.erase = function(){
if (!this.getID()){
return false;
}
Scholar.debug('Deleting item ' + this.getID());
var changedItems = [];
Scholar.DB.beginTransaction();
// Remove item from parent collections
var parentCollectionIDs = this.getCollections();
for (var i=0; i<parentCollectionIDs.length; i++){
Scholar.Collections.get(parentCollectionIDs[i]).removeItem(this.getID());
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// Note
if (this.isNote()){
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// Decrement note count of source items
var sql = "SELECT sourceItemID FROM itemNotes WHERE itemID=" + this.getID();
var sourceItemID = Scholar.DB.valueQuery(sql);
if (sourceItemID){
var sourceItem = Scholar.Items.get(sourceItemID);
sourceItem.decrementNoteCount();
changedItems.push(sourceItemID);
}
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// File
else if (this.isFile()){
// Decrement file count of source items
var sql = "SELECT sourceItemID FROM itemFiles WHERE itemID=" + this.getID();
var sourceItemID = Scholar.DB.valueQuery(sql);
if (sourceItemID){
var sourceItem = Scholar.Items.get(sourceItemID);
sourceItem.decrementFileCount();
changedItems.push(sourceItemID);
}
// Delete associated files
var linkMode = this.getFileLinkMode();
switch (linkMode){
case Scholar.Files.LINK_MODE_LINKED_FILE:
case Scholar.Files.LINK_MODE_LINKED_URL:
// Links only -- nothing to delete
break;
default:
var file = Scholar.getStorageDirectory();
file.append(this.getID());
if (file.exists()){
file.remove(true);
}
}
}
// If regular item, unassociate any notes or files for which this is a source
else {
// TODO: option for deleting child notes instead of unlinking
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// Notes
var sql = "SELECT itemID FROM itemNotes WHERE sourceItemID=" + this.getID();
var childNotes = Scholar.DB.columnQuery(sql);
if (childNotes){
changedItems.push(childNotes);
}
var sql = "UPDATE itemNotes SET sourceItemID=NULL WHERE sourceItemID="
+ this.getID();
Scholar.DB.query(sql);
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// Files
var sql = "SELECT itemID FROM itemFiles WHERE sourceItemID=" + this.getID();
var childFiles = Scholar.DB.columnQuery(sql);
if (childFiles){
changedItems.push(childFiles);
}
var sql = "UPDATE itemFiles SET sourceItemID=NULL WHERE sourceItemID="
+ this.getID();
Scholar.DB.query(sql);
}
// Flag See Also links for notification
var seeAlso = this.getSeeAlso();
if (seeAlso){
changedItems = changedItems.concat(seeAlso);
}
sql = 'DELETE FROM itemCreators WHERE itemID=' + this.getID() + ";\n";
sql += 'DELETE FROM itemNotes WHERE itemID=' + this.getID() + ";\n";
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
sql += 'DELETE FROM itemFiles WHERE itemID=' + this.getID() + ";\n";
sql += 'DELETE FROM itemSeeAlso WHERE itemID=' + this.getID() + ";\n";
sql += 'DELETE FROM itemSeeAlso WHERE linkedItemID=' + this.getID() + ";\n";
sql += 'DELETE FROM itemTags WHERE itemID=' + this.getID() + ";\n";
sql += 'DELETE FROM itemData WHERE itemID=' + this.getID() + ";\n";
sql += 'DELETE FROM items WHERE itemID=' + this.getID() + ";\n";
Scholar.DB.query(sql);
Scholar.Creators.purge();
try {
Scholar.DB.commitTransaction();
}
catch (e){
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// On failure, reset count of source items
if (sourceItem){
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
if (this.isNote()){
sourceItem.incrementNoteCount();
}
else if (this.isFile()){
sourceItem.incrementFileCount();
}
}
Scholar.DB.rollbackTransaction();
throw (e);
}
2006-06-02 01:17:44 +00:00
Scholar.Items.unload(this.getID());
// Send notification of changed items
if (changedItems.length){
Scholar.Notifier.trigger('modify', 'item', changedItems);
}
// If we're not in the middle of a larger commit, trigger the notifier now
if (!Scholar.DB.transactionInProgress()){
Scholar.Notifier.trigger('delete', 'item', this.getID());
}
}
Scholar.Item.prototype.isCollection = function(){
return false;
}
Scholar.Item.prototype.toString = function(){
return this.getTitle();
}
/**
* Convert the item data into a multidimensional associative array
* for use by the export functions
**/
Scholar.Item.prototype.toArray = function(){
if (this.getID() && !this._itemDataLoaded){
this._loadItemData();
}
var arr = [];
// Primary fields
for (var i in this._data){
switch (i){
case 'itemTypeID':
arr['itemType'] = Scholar.ItemTypes.getName(this._data[i]);
break;
// Skip certain fields
case 'firstCreator':
case 'numNotes':
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
case 'numFiles':
continue;
// For the rest, just copy over
default:
arr[i] = this._data[i];
}
}
// Item metadata
for (var i in this._itemData){
arr[Scholar.ItemFields.getName(i)] = this._itemData[i];
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
if (!this.isNote() && !this.isFile()){
// Creators
arr['creators'] = [];
var creators = this.getCreators();
for (var i in creators){
arr['creators'][i] = [];
arr['creators'][i]['firstName'] = creators[i]['firstName'];
arr['creators'][i]['lastName'] = creators[i]['lastName'];
// Convert creatorTypeIDs to text
arr['creators'][i]['creatorType'] =
Scholar.CreatorTypes.getName(creators[i]['creatorTypeID']);
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
}
// Notes
if (this.isNote()){
// Don't need title for notes
delete arr['title'];
arr['note'] = this.getNote();
if (this.getSource()){
arr['sourceItemID'] = this.getSource();
}
}
// If not note, append attached notes
else {
arr['notes'] = [];
var notes = this.getNotes();
for (var i in notes){
var note = Scholar.Items.get(notes[i]);
arr['notes'].push({
itemID: note.getID(),
note: note.getNote(),
tags: note.getTags(),
seeAlso: note.getSeeAlso()
});
}
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// Append source files
if (this.isFile()){
arr['fileName'] = arr['title'];
delete arr['title'];
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
// TODO: file data
if (this.getSource()){
arr['sourceItemID'] = this.getSource();
}
}
// If not file, append attached files
else {
arr['files'] = [];
var files = this.getFiles();
for (var i in files){
var file = Scholar.Items.get(files[i]);
arr['files'].push({
itemID: file.getID(),
// TODO
tags: file.getTags(),
seeAlso: file.getSeeAlso()
});
}
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
arr['tags'] = this.getTags();
arr['seeAlso'] = this.getSeeAlso();
return arr;
}
//////////////////////////////////////////////////////////////////////////////
//
// Private Scholar.Item methods
//
//////////////////////////////////////////////////////////////////////////////
/*
* Load in the creators from the database
*/
Scholar.Item.prototype._loadCreators = function(){
if (!this.getID()){
throw ('ItemID not set for item before attempting to load creators');
}
var sql = 'SELECT C.creatorID, C.*, creatorTypeID, orderIndex '
+ 'FROM itemCreators IC '
+ 'LEFT JOIN creators C USING (creatorID) '
+ 'WHERE itemID=' + this.getID() + ' ORDER BY orderIndex';
var creators = Scholar.DB.query(sql);
this._creatorsLoaded = true;
if (!creators){
return true;
}
this._creators = new Scholar.Hash();
for (var i=0; i<creators.length; i++){
var creator = new Array();
creator['firstName'] = creators[i]['firstName'];
creator['lastName'] = creators[i]['lastName'];
creator['creatorTypeID'] = creators[i]['creatorTypeID'];
// Save creator data into Hash, indexed by orderIndex
this._creators.set(creators[i]['orderIndex'], creator);
}
return true;
}
/*
* Load in the field data from the database
*/
Scholar.Item.prototype._loadItemData = function(){
if (!this.getID()){
throw ('ItemID not set for object before attempting to load data');
}
var sql = 'SELECT ID.fieldID, value FROM itemData ID JOIN '
+ 'itemTypeFields ITF ON (ITF.itemTypeID=(SELECT itemTypeID FROM '
+ 'items WHERE itemID=?1) AND ITF.fieldID=ID.fieldID) '
+ 'WHERE itemID=?1 ORDER BY orderIndex';
var result = Scholar.DB.query(sql,[{'int':this._data['itemID']}]);
this._itemDataLoaded = true;
if (result){
for (var i=0,len=result.length; i<len; i++){
this.setField(result[i]['fieldID'], result[i]['value'], true);
}
return true;
}
else {
return false;
}
}
/*
* Primary interface for accessing Scholar items
*/
Scholar.Items = new function(){
// Private members
var _items = new Array();
// Privileged methods
this.get = get;
this.getAll = getAll;
this.reload = reload;
this.reloadAll = reloadAll;
this.getNewItemByType = getNewItemByType;
this.search = search;
this.erase = erase;
this.unload = unload;
/*
* Retrieves (and loads, if necessary) an arbitrary number of items
*
* Can be passed ids as individual parameters or as an array of ids, or both
*
* If only one argument and it's an id, return object directly;
* otherwise, return array
*/
function get(){
var toLoad = new Array();
var loaded = new Array();
if (!arguments[0]){
Scholar.debug('No arguments provided to Items.get()');
return false;
}
var ids = Scholar.flattenArguments(arguments);
for (var i=0; i<ids.length; i++){
// Check if already loaded
if (!_items[ids[i]]){
toLoad.push(ids[i]);
}
}
// New items to load
if (toLoad.length){
_load(toLoad);
}
// If single id, return the object directly
if (arguments[0] && typeof arguments[0]!='object'
&& typeof arguments[1]=='undefined'){
return _items[arguments[0]];
}
// Otherwise, build return array
for (i=0; i<ids.length; i++){
loaded.push(_items[ids[i]]);
}
return loaded;
}
/*
* Returns all items in the database
*/
function getAll(){
var sql = 'SELECT itemID FROM items';
// DEBUG: default order?
var ids = Scholar.DB.columnQuery(sql);
return this.get(ids);
}
/*
* Reloads data for specified items into internal array
*
* Can be passed ids as individual parameters or as an array of ids, or both
*/
function reload(){
if (!arguments[0]){
return false;
}
var ids = Scholar.flattenArguments(arguments);
Scholar.debug('Reloading ' + ids);
_load(ids);
return true;
}
/*
* Reloads all items
*/
function reloadAll(){
_items = new Array();
_load();
}
function getNewItemByType(itemTypeID){
return new Scholar.Item(itemTypeID);
}
function add(data, itemTypeID){
var insert = new Array();
var obj = new Scholar.Item(itemTypeID);
for (field in data){
obj.setField(data[field]);
}
var id = obj.save();
return this.get(id);
}
/**
* Fulltext search on all fields
*
* TODO: more
**/
function search(text, parentCollectionID){
if (!text){
text = '';
}
var sql = "SELECT itemID FROM items WHERE title LIKE ?1 UNION "
+ "SELECT itemID FROM itemData WHERE value LIKE ?1 UNION "
+ "SELECT itemID FROM itemCreators WHERE creatorID IN "
+ "(SELECT creatorID FROM creators WHERE firstName LIKE ?1 "
+ "OR lastName LIKE ?1) UNION "
+ "SELECT itemID FROM itemTags WHERE tagID IN "
+ "(SELECT tagID FROM tags WHERE tag LIKE ?1) UNION "
2006-06-16 08:04:01 +00:00
+ "SELECT itemID FROM itemNotes WHERE note LIKE ?1";
var sqlParams = [{'string':'%' + text + '%'}];
if (parentCollectionID){
sql = "SELECT itemID FROM (" + sql + ") WHERE itemID IN "
+ "(SELECT itemID FROM collectionItems WHERE collectionID=?2)";
sqlParams.push({'int':parentCollectionID});
}
return Scholar.DB.columnQuery(sql, sqlParams);
}
/**
* Delete item from database and clear from internal array
**/
function erase(id){
var obj = this.get(id);
obj.erase(); // calls unload()
obj = undefined;
}
/**
* Clear item from internal array (used by Scholar.Item.erase())
**/
function unload(id){
delete _items[id];
}
function _load(){
// Should be the same as query in Scholar.Item.loadFromID, just
// without itemID clause
var sql = 'SELECT I.*, lastName || '
+ 'CASE ((SELECT COUNT(*) FROM itemCreators WHERE itemID=I.itemID)>1) '
2006-06-25 05:43:00 +00:00
+ "WHEN 0 THEN '' ELSE ' et al.' END AS firstCreator, "
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
+ "(SELECT COUNT(*) FROM itemNotes WHERE sourceItemID=I.itemID) AS numNotes, "
+ "(SELECT COUNT(*) FROM itemFiles WHERE sourceItemID=I.itemID) AS numFiles "
+ 'FROM items I '
+ 'LEFT JOIN itemCreators IC ON (I.itemID=IC.itemID) '
+ 'LEFT JOIN creators C ON (IC.creatorID=C.creatorID) '
+ 'WHERE (IC.orderIndex=0 OR IC.orderIndex IS NULL)';
if (arguments[0]){
sql += ' AND I.itemID IN (' + Scholar.join(arguments,',') + ')';
}
var result = Scholar.DB.query(sql);
if (result){
for (var i=0,len=result.length; i<len; i++){
// Item doesn't exist -- create new object and stuff in array
if (!_items[result[i]['itemID']]){
var obj = new Scholar.Item();
obj.loadFromRow(result[i]);
_items[result[i]['itemID']] = obj;
}
// Existing item -- reload in place
else {
_items[result[i]['itemID']].loadFromRow(result[i]);
}
}
}
return true;
}
}
Scholar.Notes = new function(){
this.add = add;
/**
* Create a new item of type 'note' and add the note text to the itemNotes table
*
* Returns the itemID of the new note item
**/
function add(text, sourceItemID){
Scholar.DB.beginTransaction();
if (sourceItemID){
var sourceItem = Scholar.Items.get(sourceItemID);
if (!sourceItem){
Scholar.DB.commitTransaction();
throw ("Cannot set note source to invalid item " + sourceItemID);
}
if (sourceItem.isNote()){
Scholar.DB.commitTransaction();
throw ("Cannot set note source to another note (" + sourceItemID + ")");
}
}
var note = Scholar.Items.getNewItemByType(Scholar.ItemTypes.getID('note'));
note.save();
var sql = "INSERT INTO itemNotes VALUES (?,?,?)";
var bindParams = [
note.getID(),
(sourceItemID ? {int:sourceItemID} : null),
{string:text}
];
Scholar.DB.query(sql, bindParams);
Scholar.DB.commitTransaction();
if (sourceItemID){
sourceItem.incrementNoteCount();
Scholar.Notifier.trigger('modify', 'item', sourceItemID);
}
Scholar.Notifier.trigger('add', 'item', note.getID());
return note.getID();
}
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
Scholar.Files = new function(){
this.LINK_MODE_IMPORTED_FILE = 0;
this.LINK_MODE_IMPORTED_URL = 1;
this.LINK_MODE_LINKED_FILE = 2;
this.LINK_MODE_LINKED_URL = 3;
this.importFromFile = importFromFile;
this.linkFromFile = linkFromFile;
this.linkFromDocument = linkFromDocument;
this.importFromDocument = importFromDocument;
function importFromFile(file, sourceItemID){
var title = file.leafName;
Scholar.DB.beginTransaction();
// Create a new file item
var fileItem = Scholar.Items.getNewItemByType(Scholar.ItemTypes.getID('file'));
fileItem.setField('title', title);
fileItem.save();
var itemID = fileItem.getID();
// Create directory for item files within storage directory
var destDir = Scholar.getStorageDirectory();
destDir.append(itemID);
destDir.create(Components.interfaces.nsIFile.DIRECTORY_TYPE, 0644);
try {
file.copyTo(destDir, null);
}
catch (e){
// hmph
Scholar.DB.rollbackTransaction();
destDir.remove(true);
throw (e);
}
// Point to copied file
var newFile = Components.classes["@mozilla.org/file/local;1"]
.createInstance(Components.interfaces.nsILocalFile);
newFile.initWithFile(destDir);
newFile.append(title);
var mimeType = _getMIMETypeFromFile(newFile);
var charsetID = _getCharsetIDFromFile(newFile);
_addToDB(newFile, null, null, this.LINK_MODE_IMPORTED_FILE, mimeType, charsetID, sourceItemID, itemID);
Scholar.DB.commitTransaction();
return itemID;
}
function linkFromFile(file, sourceItemID){
var title = file.leafName;
var mimeType = _getMIMETypeFromFile(file);
var charsetID = _getCharsetIDFromFile(file);
return _addToDB(file, null, title, this.LINK_MODE_LINKED_FILE, mimeType, charsetID, sourceItemID);
}
// TODO: what if called on file:// document?
function linkFromDocument(document, sourceItemID){
var url = document.location;
var title = document.title; // TODO: don't use Mozilla-generated title for images, etc.
var mimeType = document.contentType;
var charsetID = Scholar.CharacterSets.getID(document.characterSet);
return _addToDB(null, url, title, this.LINK_MODE_LINKED_URL, mimeType, charsetID, sourceItemID);
}
function importFromDocument(document, sourceItemID){
var url = document.location;
var title = document.title;
var mimeType = document.contentType;
var charsetID = Scholar.CharacterSets.getID(document.characterSet);
const nsIWBP = Components.interfaces.nsIWebBrowserPersist;
var wbp = Components
.classes["@mozilla.org/embedding/browser/nsWebBrowserPersist;1"]
.createInstance(nsIWBP);
//wbp.persistFlags = nsIWBP.PERSIST_FLAGS...;
var encodingFlags = false;
Scholar.DB.beginTransaction();
// Create a new file item
var fileItem = Scholar.Items.getNewItemByType(Scholar.ItemTypes.getID('file'));
fileItem.setField('title', title);
fileItem.save();
var itemID = fileItem.getID();
// Create a new folder for this item in the storage directory
var destDir = Scholar.getStorageDirectory();
destDir.append(itemID);
destDir.create(Components.interfaces.nsIFile.DIRECTORY_TYPE, 0644);
var file = Components.classes["@mozilla.org/file/local;1"].
createInstance(Components.interfaces.nsILocalFile);
file.initWithFile(destDir);
file.append(_getFileNameFromURL(url, mimeType));
wbp.saveDocument(document, file, destDir, mimeType, encodingFlags, false);
_addToDB(file, url, title, this.LINK_MODE_IMPORTED_URL, mimeType, charsetID, sourceItemID, itemID);
Scholar.DB.commitTransaction();
return itemID;
}
// TODO: currently only uses file extension
function _getMIMETypeFromFile(file){
var ms = Components
.classes['@mozilla.org/uriloader/external-helper-app-service;1']
.getService(Components.interfaces.nsIMIMEService);
return ms.getTypeFromFile(file);
}
function _getCharsetIDFromFile(file){
// TODO: Not yet implemented
return null;
}
function _getFileNameFromURL(url, mimeType){
var nsIURL = Components.classes["@mozilla.org/network/standard-url;1"]
.createInstance(Components.interfaces.nsIURL);
nsIURL.spec = url;
if (nsIURL.fileName){
return nsIURL.fileName;
}
if (mimeType){
var ext = Components.classes["@mozilla.org/mime;1"]
.getService(Components.interfaces.nsIMIMEService)
.getPrimaryExtension(mimeType, nsIURL.fileExt ? nsIURL.fileExt : null);
}
return nsIURL.host + (ext ? '.' + ext : '');
}
/**
* Create a new item of type 'file' and add the file link to the itemFiles table
*
* Passing an itemID causes it to skip new item creation and use the specified
* item instead -- used when importing files (since we have to know
* the itemID before copying in a file and don't want to update the DB before
* the file is saved)
*
* Returns the itemID of the new file item
**/
function _addToDB(file, url, title, linkMode, mimeType, charsetID, sourceItemID, itemID){
if (url){
var path = url;
}
if (file){
if (linkMode==this.LINK_MODE_IMPORTED_URL){
var originalPath = path;
}
// Path relative to Scholar directory for external files and relative
// to storage directory for imported files
var refDir = (linkMode==this.LINK_MODE_LINKED_FILE)
? Scholar.getScholarDirectory() : Scholar.getStorageDirectory();
var path = file.getRelativeDescriptor(refDir);
}
Scholar.DB.beginTransaction();
if (sourceItemID){
var sourceItem = Scholar.Items.get(sourceItemID);
if (!sourceItem){
Scholar.DB.commitTransaction();
throw ("Cannot set file source to invalid item " + sourceItemID);
}
if (sourceItem.isFile()){
Scholar.DB.commitTransaction();
throw ("Cannot set file source to another file (" + sourceItemID + ")");
}
}
// If an itemID is provided, use that
if (itemID){
var fileItem = Scholar.Items.get(itemID);
if (!fileItem.isFile()){
throw ("Item " + itemID + " is not a valid file item in _addToDB()");
}
}
// Otherwise create a new file item
else {
var fileItem = Scholar.Items.getNewItemByType(Scholar.ItemTypes.getID('file'));
fileItem.setField('title', title);
fileItem.save();
}
var sql = "INSERT INTO itemFiles (itemID, sourceItemID, linkMode, "
+ "mimeType, charsetID, path, originalPath) VALUES (?,?,?,?,?,?,?)";
var bindParams = [
fileItem.getID(),
(sourceItemID ? {int:sourceItemID} : null),
{int:linkMode},
{string:mimeType},
(charsetID ? {int:charsetID} : null),
{string:path},
(originalPath ? {string:originalPath} : null)
];
Scholar.DB.query(sql, bindParams);
Scholar.DB.commitTransaction();
if (sourceItemID){
sourceItem.incrementNoteCount();
Scholar.Notifier.trigger('modify', 'item', sourceItemID);
}
Scholar.Notifier.trigger('add', 'item', fileItem.getID());
return fileItem.getID();
}
}
/*
* Constructor for Collection object
*
* Generally should be called from Scholar.Collection rather than directly
*/
Scholar.Collection = function(){
this._init();
}
Scholar.Collection.prototype._init = function(){
//
// Public members for access by public methods -- do not access directly
//
this._id;
this._name;
this._parent;
this._hasChildCollections;
this._hasChildItems;
this._childItems = new Scholar.Hash();
this._childItemsLoaded;
}
/*
* Build collection from database
*/
Scholar.Collection.prototype.loadFromID = function(id){
// Should be same as query in Scholar.Collections, just with collectionID
var sql = "SELECT collectionID, collectionName, parentCollectionID, "
+ "(SELECT COUNT(*) FROM collections WHERE "
+ "parentCollectionID=C.collectionID)!=0 AS hasChildCollections, "
+ "(SELECT COUNT(*) FROM collectionItems WHERE "
+ "collectionID=C.collectionID)!=0 AS hasChildItems "
+ "FROM collections C "
+ "WHERE collectionID=" + id;
var row = Scholar.DB.rowQuery(sql);
this.loadFromRow(row);
}
/*
* Populate collection data from a database row
*/
Scholar.Collection.prototype.loadFromRow = function(row){
this._init();
this._id = row['collectionID'];
this._name = row['collectionName'];
this._parent = row['parentCollectionID'];
this._hasChildCollections = row['hasChildCollections'];
this._hasChildItems = row['hasChildItems'];
}
Scholar.Collection.prototype.getID = function(){
return this._id;
}
Scholar.Collection.prototype.getName = function(){
return this._name;
}
2006-06-02 01:17:44 +00:00
/**
* Returns collectionID of the parent collection
2006-06-02 01:17:44 +00:00
**/
Scholar.Collection.prototype.getParent = function(){
return this._parent;
}
Scholar.Collection.prototype.isEmpty = function(){
return !(parseInt(this._hasChildCollections)) && !(parseInt(this._hasChildItems));
}
Scholar.Collection.prototype.hasChildCollections = function(){
return !!(parseInt(this._hasChildCollections));
}
Scholar.Collection.prototype.hasChildItems = function(){
return !!(parseInt(this._hasChildItems));
}
/**
* Rename the collection
*
* _name_ is non-empty string
*
* Returns true on success, or false on error
**/
Scholar.Collection.prototype.rename = function(name){
if (!name){
return false;
}
var sql = "UPDATE collections SET collectionName=? "
+ "WHERE collectionID=?";
Scholar.DB.query(sql, [{'string':name},{'int':this.getID()}]);
this._name = name;
Scholar.Notifier.trigger('modify', 'collection', this.getID());
return true;
}
/**
* Change the parentCollectionID of a collection
*
* Returns TRUE on success, FALSE on error
**/
Scholar.Collection.prototype.changeParent = function(parent){
if (!parent){
parent = null;
}
var previousParent = this.getParent();
if (parent==previousParent){
Scholar.debug('Collection ' + this.getID() + ' is already in '
+ (parent ? 'collection ' + parent : 'root collection'), 2);
return false;
}
if (parent && !Scholar.Collections.get(parent)){
throw('Invalid parentCollectionID ' + parent + ' in changeParent()');
}
if (parent && parent==this.getID()){
Scholar.debug('Cannot move collection into itself!', 2);
return false;
}
if (parent){
if (this.hasDescendent('collection', parent)){
Scholar.debug('Cannot move collection into one of its own '
+ 'descendents!', 2);
return false;
}
}
var parentParam = parent ? {'int':parent} : {'null':true};
var sql = "UPDATE collections SET parentCollectionID=? "
+ "WHERE collectionID=?";
Scholar.DB.query(sql, [parentParam, {'int':this.getID()}]);
this._parent = parent;
var notifyIDs = [
this.getID(),
(previousParent ? previousParent : null),
(parent ? parent : null)
];
// TODO: only reload the necessary ones
Scholar.Collections.reloadAll();
Scholar.Notifier.trigger('move', 'collection', notifyIDs);
return true;
}
/**
* Add an item to the collection
**/
Scholar.Collection.prototype.addItem = function(itemID){
Scholar.DB.beginTransaction();
if (!Scholar.Items.get(itemID)){
Scholar.DB.rollbackTransaction();
throw(itemID + ' is not a valid item id');
}
var nextOrderIndex = Scholar.DB.valueQuery("SELECT IFNULL(MAX(orderIndex)+1, 0) "
+ "FROM collectionItems WHERE collectionID=" + this._id);
var sql = "INSERT OR IGNORE INTO collectionItems VALUES "
+ "(" + this._id + ", " + itemID + ", " + nextOrderIndex + ")";
Scholar.DB.query(sql);
Scholar.DB.commitTransaction();
this._childItems.set(itemID);
// If this was previously empty, update and send a notification to the tree
if (!this._hasChildItems){
this._hasChildItems = true;
Scholar.Notifier.trigger('modify', 'collection', this.getID());
}
Scholar.Notifier.trigger('add', 'item', itemID);
}
/**
* Remove an item from the collection (does not delete item from library)
**/
Scholar.Collection.prototype.removeItem = function(itemID){
Scholar.DB.beginTransaction();
var sql = "SELECT orderIndex FROM collectionItems "
+ "WHERE collectionID=" + this._id + " AND itemID=" + itemID;
var orderIndex = Scholar.DB.valueQuery(sql);
if (orderIndex===false){
Scholar.debug('Item ' + itemID + ' is not a child of collection '
+ this._id);
Scholar.DB.rollbackTransaction();
return false;
}
var sql = "DELETE FROM collectionItems WHERE collectionID=" + this._id
+ " AND itemID=" + itemID;
Scholar.DB.query(sql);
// Move down items above deleted item in collection
sql = 'UPDATE collectionItems SET orderIndex=orderIndex-1 '
+ 'WHERE collectionID=' + this._id
+ ' AND orderIndex>' + orderIndex;
Scholar.DB.query(sql);
Scholar.DB.commitTransaction();
this._childItems.remove(itemID);
// If this was the last item, set collection to empty
if (!this._childItems.length){
this._hasChildItems = false;
Scholar.Notifier.trigger('modify', 'collection', this.getID());
}
Scholar.Notifier.trigger('remove', 'item', itemID);
}
/**
* Check if an item belongs to the collection
**/
Scholar.Collection.prototype.hasItem = function(itemID){
if (!this._childItemsLoaded){
this._loadChildItems();
}
return this._childItems.has(itemID);
}
Scholar.Collection.prototype.hasDescendent = function(type, id){
var descendents = this._getDescendents();
for (var i=0, len=descendents.length; i<len; i++){
if (descendents[i]['type']==type && descendents[i]['id']==id){
return true;
}
}
return false;
}
/**
* Deletes collection and all descendent collections and items
**/
Scholar.Collection.prototype.erase = function(deleteItems){
Scholar.DB.beginTransaction();
var descendents = this._getDescendents();
var collections = [this.getID()], items = [];
for(var i=0, len=descendents.length; i<len; i++){
// Descendent collections
if (descendents[i]['type']=='collection'){
collections.push(descendents[i]['id']);
}
// Descendent items
else {
if (deleteItems){
// Delete items from DB
Scholar.Items.get(descendents[i]['id']).erase();
items.push(descendents[i]['id']);
}
}
}
// Remove item associations for all descendent collections
Scholar.DB.query('DELETE FROM collectionItems WHERE collectionID IN ('
+ collections.join() + ')');
// And delete all descendent collections
Scholar.DB.query('DELETE FROM collections WHERE collectionID IN ('
+ collections.join() + ')');
Scholar.DB.commitTransaction();
// Clear deleted collection from internal memory
Scholar.Collections.unload(collections);
2006-06-02 01:17:44 +00:00
Scholar.Notifier.trigger('remove', 'collection', collections);
if (items.length){
Scholar.Notifier.trigger('delete', 'item', items);
}
}
Scholar.Collection.prototype.isCollection = function(){
return true;
}
Scholar.Collection.prototype.toArray = function(){
return this._getDescendents(true);
}
Scholar.Collection.prototype._loadChildItems = function(){
this._childItems = new Scholar.Hash();
var sql = "SELECT itemID FROM collectionItems WHERE collectionID=" + this._id;
var itemIDs = Scholar.DB.columnQuery(sql);
if (!itemIDs){
Scholar.debug('Collection ' + this._id + ' has no child items');
}
for (var i=0; i<itemIDs.length; i++){
this._childItems.set(itemIDs[i]);
}
this._childItemsLoaded = true;
}
/**
* Returns an array of descendent collections and items
* (rows of 'id', 'type' ('item' or 'collection'), and, if collection, 'name')
*
* nested: Return multidimensional array with 'children' nodes instead of flat array
**/
Scholar.Collection.prototype._getDescendents = function(nested){
var toReturn = new Array();
// 0 == collection
// 1 == item
var children = Scholar.DB.query('SELECT collectionID AS id, '
+ "0 AS type, collectionName AS collectionName "
+ 'FROM collections WHERE parentCollectionID=' + this._id
+ ' UNION SELECT itemID AS id, 1 AS type, NULL AS collectionName '
+ 'FROM collectionItems WHERE collectionID=' + this._id);
for(var i=0, len=children.length; i<len; i++){
switch (children[i]['type']){
case 0:
toReturn.push({
id: children[i]['id'],
name: children[i]['collectionName'],
type: 'collection'
});
var descendents =
Scholar.Collections.get(children[i]['id'])._getDescendents(nested);
if (nested){
toReturn[toReturn.length-1]['children'] = descendents;
}
else {
for(var j=0, len2=descendents.length; j<len2; j++){
toReturn.push(descendents[j]);
}
}
break;
case 1:
toReturn.push({
id: children[i]['id'],
type: 'item'
});
break;
}
}
return toReturn;
}
/*
* Primary interface for accessing Scholar collection
*/
Scholar.Collections = new function(){
var _collections = new Array();
var _collectionsLoaded = false;
this.get = get;
this.add = add;
this.reloadAll = reloadAll;
this.unload = unload;
/*
* Returns a Scholar.Collection object for a collectionID
*/
function get(id){
if (!_collectionsLoaded){
_load();
}
return (typeof _collections[id]!='undefined') ? _collections[id] : false;
}
/**
* Add new collection to DB and return Collection object
*
* _name_ is non-empty string
* _parent_ is optional collectionID -- creates root collection by default
*
* Returns true on success; false on error
**/
function add(name, parent){
if (!name){
return false;
}
Scholar.DB.beginTransaction();
if (parent && !this.get(parent)){
Scholar.DB.rollbackTransaction();
throw('Cannot add collection to invalid parent ' + parent);
}
var parentParam = parent ? {'int':parent} : {'null':true};
var rnd = Scholar.getRandomID('collections', 'collectionID');
var sql = "INSERT INTO collections VALUES (?,?,?)";
var sqlValues = [ {'int':rnd}, {'string':name}, parentParam ];
Scholar.DB.query(sql, sqlValues);
Scholar.DB.commitTransaction();
_load(rnd);
Scholar.Notifier.trigger('add', 'collection', rnd);
return this.get(rnd);
}
/**
* Clears internal cache and reloads collection data from DB
**/
function reloadAll(){
_collections = new Array();
_load();
}
/**
* Clear collection from internal cache (used by Scholar.Collection.erase())
*
* Can be passed ids as individual parameters or as an array of ids, or both
**/
function unload(){
var ids = Scholar.flattenArguments(arguments);
for(var i=0; i<ids.length; i++){
delete _collections[ids[i]];
}
}
/**
* Loads collection data from DB and adds to internal cache
**/
function _load(){
// This should be the same as the query in Scholar.Collection.loadFromID,
// just without a specific collectionID
var sql = "SELECT collectionID, collectionName, parentCollectionID, "
+ "(SELECT COUNT(*) FROM collections WHERE "
+ "parentCollectionID=C.collectionID)!=0 AS hasChildCollections, "
+ "(SELECT COUNT(*) FROM collectionItems WHERE "
+ "collectionID=C.collectionID)!=0 AS hasChildItems "
+ "FROM collections C";
var ids = Scholar.flattenArguments(arguments)
if (ids.length){
sql += " WHERE collectionID IN (" + ids.join() + ")";
}
var result = Scholar.DB.query(sql);
if (!result){
throw ('No collections found');
}
for (var i=0; i<result.length; i++){
var collectionID = result[i]['collectionID'];
// If collection doesn't exist, create new object and stuff in array
if (!_collections[collectionID]){
var collection = new Scholar.Collection();
collection.loadFromRow(result[i]);
_collections[collectionID] = collection;
}
// If existing collection, reload in place
else {
_collections[collectionID].loadFromRow(result[i]);
}
}
_collectionsLoaded = true;
}
}
/*
* Same structure as Scholar.Tags -- make changes in both places if possible
*/
Scholar.Creators = new function(){
var _creators = new Array; // indexed by first%%%last hash
var _creatorsByID = new Array; // indexed by creatorID
this.get = get;
this.getID = getID;
this.add = add;
this.purge = purge;
var self = this;
/*
* Returns an array of creator data for a given creatorID
*/
function get(creatorID){
if (_creatorsByID[creatorID]){
return _creatorsByID[creatorID];
}
var sql = 'SELECT * FROM creators WHERE creatorID=' + creatorID;
var result = Scholar.DB.rowQuery(sql);
if (!result){
return false;
}
_creatorsByID[creatorID] = result;
return result;
}
/*
* Returns the creatorID matching given name and type
*/
function getID(firstName, lastName){
var hash = firstName + '%%%' + lastName;
if (_creators[hash]){
return _creators[hash];
}
var sql = 'SELECT creatorID FROM creators '
+ 'WHERE firstName=? AND lastName=?';
var params = [{string: firstName}, {string: lastName}];
var creatorID = Scholar.DB.valueQuery(sql, params);
if (creatorID){
_creators[hash] = creatorID;
}
return creatorID;
}
/*
* Add a new creator to the database
*
* Returns new creatorID
*/
function add(firstName, lastName){
Scholar.debug('Adding new creator', 4);
Scholar.DB.beginTransaction();
var sql = 'INSERT INTO creators VALUES (?,?,?)';
var rnd = Scholar.getRandomID('creators', 'creatorID');
var params = [{int: rnd}, {string: firstName}, {string: lastName}];
Scholar.DB.query(sql, params);
Scholar.DB.commitTransaction();
return rnd;
}
/*
* Delete obsolete creators from database and clear internal array entries
*
* Returns removed creatorIDs on success
*/
function purge(){
var sql = 'SELECT creatorID FROM creators WHERE creatorID NOT IN '
+ '(SELECT creatorID FROM itemCreators);';
var toDelete = Scholar.DB.columnQuery(sql);
if (!toDelete){
return false;
}
// Clear creator entries in internal array
for (var i=0; i<toDelete.length; i++){
var hash = _getHash(toDelete[i]);
delete _creators[hash];
delete _creatorsByID[toDelete[i]];
}
sql = 'DELETE FROM creators WHERE creatorID NOT IN '
+ '(SELECT creatorID FROM itemCreators);';
var result = Scholar.DB.query(sql);
return toDelete;
}
function _getHash(creatorID){
var creator = self.get(creatorID);
if (!creator){
return false;
}
return creator['firstName'] + '%%%' + creator['lastName'];
}
}
/*
* Same structure as Scholar.Creators -- make changes in both places if possible
*/
Scholar.Tags = new function(){
var _tags = new Array; // indexed by tag text
var _tagsByID = new Array; // indexed by tagID
this.getName = getName;
this.getID = getID;
this.add = add;
this.purge = purge;
/*
* Returns a tag for a given tagID
*/
function getName(tagID){
if (_tagsByID[tagID]){
return _tagsByID[tagID];
}
var sql = 'SELECT tag FROM tags WHERE tagID=' + tagID;
var result = Scholar.DB.valueQuery(sql);
if (!result){
return false;
}
_tagsByID[tagID] = result;
return result;
}
/*
* Returns the tagID matching given tag
*/
function getID(tag){
if (_tags[tag]){
return _tags[tag];
}
var sql = 'SELECT tagID FROM tags WHERE tag=?';
var tagID = Scholar.DB.valueQuery(sql, [{string:tag}]);
if (tagID){
_tags[tag] = tagID;
}
return tagID;
}
/*
* Add a new tag to the database
*
* Returns new tagID
*/
function add(tag){
Scholar.debug('Adding new tag', 4);
Scholar.DB.beginTransaction();
var sql = 'INSERT INTO tags VALUES (?,?)';
var rnd = Scholar.getRandomID('tags', 'tagID');
Scholar.DB.query(sql, [{int: rnd}, {string: tag}]);
Scholar.DB.commitTransaction();
return rnd;
}
/*
* Delete obsolete tags from database and clear internal array entries
*
* Returns removed tagIDs on success
*/
function purge(){
var sql = 'SELECT tagID FROM tags WHERE tagID NOT IN '
+ '(SELECT tagID FROM itemTags);';
var toDelete = Scholar.DB.columnQuery(sql);
if (!toDelete){
return false;
}
// Clear tag entries in internal array
for (var i=0; i<toDelete.length; i++){
var tag = this.getName(toDelete[i]);
delete _tags[tag];
delete _tagsByID[toDelete[i]];
}
sql = 'DELETE FROM tags WHERE tagID NOT IN '
+ '(SELECT tagID FROM itemTags);';
var result = Scholar.DB.query(sql);
return toDelete;
}
}
/*
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
* Same structure as Scholar.ItemTypes and FileTypes --
* make changes in both places if possible
*/
Scholar.CreatorTypes = new function(){
var _types = new Array();
var _typesLoaded;
var self = this;
this.getName = getName;
this.getID = getID;
this.getTypes = getTypes;
function getName(idOrName){
if (!_typesLoaded){
_load();
}
if (!_types[idOrName]){
Scholar.debug('Invalid creator type ' + idOrName, 1);
}
return _types[idOrName]['name'];
}
function getID(idOrName){
if (!_typesLoaded){
_load();
}
if (!_types[idOrName]){
Scholar.debug('Invalid creator type ' + idOrName, 1);
}
return _types[idOrName]['id'];
}
function getTypes(){
return Scholar.DB.query('SELECT creatorTypeID AS id, '
+ 'creatorType AS name FROM creatorTypes order BY creatorType');
}
function _load(){
var types = self.getTypes();
for (i in types){
// Store as both id and name for access by either
var typeData = {
id: types[i]['id'],
name: types[i]['name']
}
_types[types[i]['id']] = typeData;
_types[types[i]['name']] = _types[types[i]['id']];
}
_typesLoaded = true;
}
}
/*
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
* Same structure as Scholar.CreatorTypes and FileTypes --
* make changes in both places if possible
*/
Scholar.ItemTypes = new function(){
var _types = new Array();
var _typesLoaded;
var self = this;
this.getName = getName;
this.getID = getID;
this.getTypes = getTypes;
function getName(idOrName){
if (!_typesLoaded){
_load();
}
if (!_types[idOrName]){
Scholar.debug('Invalid item type ' + idOrName, 1);
}
return _types[idOrName]['name'];
}
function getID(idOrName){
if (!_typesLoaded){
_load();
}
if (!_types[idOrName]){
Scholar.debug('Invalid item type ' + idOrName, 1);
}
return _types[idOrName]['id'];
}
function getTypes(){
return Scholar.DB.query('SELECT itemTypeID AS id, typeName AS name '
+ 'FROM itemTypes order BY typeName');
}
function _load(){
var types = self.getTypes();
for (i in types){
// Store as both id and name for access by either
var typeData = {
id: types[i]['id'],
name: types[i]['name']
}
_types[types[i]['id']] = typeData;
_types[types[i]['name']] = _types[types[i]['id']];
}
_typesLoaded = true;
}
}
Addresses #17, add filesystem/ability to store files Not finished, but enough to give David something to work with No BLOBs -- just linking/importing of files and loaded documents New Scholar.Item methods: incrementFileCount() (used internally) decrementFileCount() (used internally) isFile() numFiles() getFile() -- returns nsILocalFile or false if associated file doesn't exist (note: always returns false for items with LINK_MODE_LINKED_URL, since they have no files -- use getFileURL() instead) getFileURL() -- returns URL string getFileLinkMode() -- compare to Scholar.Files.LINK_MODE_* constants: LINKED_FILE, IMPORTED_FILE, LINKED_URL, IMPORTED_URL getFileMimeType() -- mime type of file (e.g. text/plain) getFileCharset() -- charsetID of file getFiles() -- array of file itemIDs this file is a source for New Scholar.Files methods: importFromFile(nsIFile file [, int sourceItemID]) linkFromFile(nsIFile file [, int sourceItemID]) importFromDocument(nsIDOMDocument document [, int sourceItemID]) linkFromDocument(nsIDOMDocument document [, int sourceItemID]) New class Scholar.FileTypes -- partially implemented, not yet used New class Scholar.CharacterSets -- same as other *Types classes: getID(idOrName) getName(idOrName) getTypes() (aliased to getAll(), which I'll probably change the others to as well) Charsets table with all official character sets (copied from Mozilla source) Renamed Item.setNoteSource() to setSource() and Item.getNoteSource() to getSource() and adjusted to handle both notes and files
2006-07-27 09:16:02 +00:00
/*
* Same structure as Scholar.ItemTypes and CreatorTypes --
* make changes in both places if possible
*/
Scholar.FileTypes = new function(){
var _types = new Array();
var _typesLoaded;
var self = this;
this.getName = getName;
this.getID = getID;
this.getIDFromMIMEType = getIDFromMIMEType;
this.getTypes = getTypes;
function getName(idOrName){
if (!_typesLoaded){
_load();
}
if (!_types[idOrName]){
Scholar.debug('Invalid file type ' + idOrName, 1);
}
return _types[idOrName]['name'];
}
function getID(idOrName){
if (!_typesLoaded){
_load();
}
if (!_types[idOrName]){
Scholar.debug('Invalid file type ' + idOrName, 1);
}
return _types[idOrName]['id'];
}
function getIDFromMIMEType(mimeType){
// TODO
}
function getTypes(){
return Scholar.DB.query('SELECT fileTypeID AS id, '
+ 'fileType AS name FROM fileTypes order BY fileType');
}
function _load(){
var types = self.getTypes();
for (i in types){
// Store as both id and name for access by either
var typeData = {
id: types[i]['id'],
name: types[i]['name']
}
_types[types[i]['id']] = typeData;
_types[types[i]['name']] = _types[types[i]['id']];
}
_typesLoaded = true;
}
}
/*
* Same structure as Scholar.ItemTypes, CreatorTypes, etc. --
* make changes in all versions if possible
*/
Scholar.CharacterSets = new function(){
var _types = new Array();
var _typesLoaded;
var self = this;
var _typeDesc = 'character set';
var _idCol = 'charsetID';
var _nameCol = 'charset';
var _table = 'charsets';
var _ignoreCase = true;
this.getName = getName;
this.getID = getID;
this.getTypes = getTypes;
this.getAll = getAll;
function getName(idOrName){
if (!_typesLoaded){
_load();
}
if (_ignoreCase){
idOrName = idOrName.toLowerCase();
}
if (!_types[idOrName]){
Scholar.debug('Invalid ' + _typeDesc + ' ' + idOrName, 1);
}
return _types[idOrName]['name'];
}
function getID(idOrName){
if (!_typesLoaded){
_load();
}
if (_ignoreCase){
idOrName = idOrName.toLowerCase();
}
if (!_types[idOrName]){
Scholar.debug('Invalid ' + _typeDesc + ' ' + idOrName, 1);
}
return _types[idOrName]['id'];
}
function getTypes(){
return Scholar.DB.query('SELECT ' + _idCol + ' AS id, '
+ _nameCol + ' AS name FROM ' + _table + ' order BY ' + _nameCol);
}
function getAll(){
return this.getTypes();
}
function _load(){
var types = self.getTypes();
for (i in types){
// Store as both id and name for access by either
var typeData = {
id: types[i]['id'],
name: _ignoreCase ? types[i]['name'].toLowerCase() : types[i]['name']
}
_types[types[i]['id']] = typeData;
_types[types[i]['name']] = _types[types[i]['id']];
}
_typesLoaded = true;
}
}
Scholar.ItemFields = new function(){
// Private members
var _fields = new Array();
var _fieldFormats = new Array();
var _itemTypeFields = new Array();
// Privileged methods
this.getName = getName;
this.getID = getID;
this.isValidForType = isValidForType;
this.isInteger = isInteger;
this.getItemTypeFields = getItemTypeFields;
/*
* Return the fieldName for a passed fieldID or fieldName
*/
function getName(field){
if (!_fields.length){
_loadFields();
}
return _fields[field] ? _fields[field]['name'] : false;
}
/*
* Return the fieldID for a passed fieldID or fieldName
*/
function getID(field){
if (!_fields.length){
_loadFields();
}
return _fields[field] ? _fields[field]['id'] : false;
}
function isValidForType(fieldID, itemTypeID){
if (!_fields.length){
_loadFields();
}
_fieldCheck(fieldID);
if (!_fields[fieldID]['itemTypes']){
throw('No associated itemTypes for fieldID ' + fieldID);
}
return !!_fields[fieldID]['itemTypes'][itemTypeID];
}
function isInteger(fieldID){
if (!_fields.length){
_loadFields();
}
_fieldCheck(fieldID);
var ffid = _fields[fieldID]['formatID'];
return _fieldFormats[ffid] ? _fieldFormats[ffid]['isInteger'] : false;
}
/*
* Returns an array of fieldIDs for a given item type
*/
function getItemTypeFields(itemTypeID){
if (_itemTypeFields[itemTypeID]){
return _itemTypeFields[itemTypeID];
}
var sql = 'SELECT fieldID FROM itemTypeFields '
+ 'WHERE itemTypeID=' + itemTypeID + ' ORDER BY orderIndex';
_itemTypeFields[itemTypeID] = Scholar.DB.columnQuery(sql);
return _itemTypeFields[itemTypeID];
}
/**
* Check whether a fieldID is valid, throwing an exception if not
* (since it should never actually happen)
**/
function _fieldCheck(fieldID){
if (!_fields.length){
_loadFields();
}
if (typeof _fields[fieldID]=='undefined'){
throw('Invalid fieldID ' + fieldID);
}
}
/*
* Returns hash array of itemTypeIDs for which a given field is valid
*/
function _getFieldItemTypes(){
var sql = 'SELECT fieldID, itemTypeID FROM itemTypeFields';
var results = Scholar.DB.query(sql);
if (!results){
throw ('No fields in itemTypeFields!');
}
var fields = new Array();
for (var i=0; i<results.length; i++){
if (!fields[results[i]['fieldID']]){
fields[results[i]['fieldID']] = new Array();
}
fields[results[i]['fieldID']][results[i]['itemTypeID']] = true;
}
return fields;
}
/*
* Load all fields into an internal hash array
*/
function _loadFields(){
var i,len;
var result = Scholar.DB.query('SELECT * FROM fieldFormats');
for (i=0; i<result.length; i++){
_fieldFormats[result[i]['fieldFormatID']] = {
regex: result[i]['regex'],
isInteger: result[i]['isInteger']
};
}
result = Scholar.DB.query('SELECT * FROM fields');
if (!result.length){
throw ('No fields in database!');
}
var fieldItemTypes = _getFieldItemTypes();
for (i=0,len=result.length; i<len; i++){
_fields[result[i]['fieldID']] = {
id: result[i]['fieldID'],
name: result[i]['fieldName'],
formatID: result[i]['fieldFormatID'],
itemTypes: fieldItemTypes[result[i]['fieldID']]
};
// Store by name as well as id
_fields[result[i]['fieldName']] = _fields[result[i]['fieldID']];
}
}
}
/*
* Scholar.getCollections(parent)
*
* Returns an array of all collections are children of a collection
* as Scholar.Collection instances
*
* Takes parent collectionID as optional parameter;
* by default, returns root collections
*/
Scholar.getCollections = function(parent){
var toReturn = new Array();
if (!parent){
parent = null;
}
var sql = 'SELECT collectionID FROM collections C WHERE parentCollectionID';
sql += parent ? '=' + parent : ' IS NULL';
sql += ' ORDER BY collectionName';
var children = Scholar.DB.columnQuery(sql);
if (!children){
Scholar.debug('No child collections of collection ' + parent, 5);
return toReturn;
}
for (var i=0, len=children.length; i<len; i++){
var obj = Scholar.Collections.get(children[i]);
if (!obj){
throw ('Collection ' + children[i] + ' not found');
}
toReturn.push(obj);
}
return toReturn;
}
/*
* Scholar.getItems(parent)
*
* Returns an array of all items that are children of a collection--or all
* items if no parent provided--as Scholar.Item instances
*/
Scholar.getItems = function(parent){
var toReturn = new Array();
if (!parent){
var sql = "SELECT itemID FROM items LEFT JOIN itemNotes USING (itemID) "
+ "WHERE sourceItemID IS NULL";
}
else {
var sql = 'SELECT itemID FROM collectionItems '
+ 'WHERE collectionID=' + parent;
}
var children = Scholar.DB.columnQuery(sql);
if (!children){
if (!parent){
Scholar.debug('No items in library', 5);
}
else {
Scholar.debug('No child items of collection ' + parent, 5);
}
return toReturn;
}
return Scholar.Items.get(children);
}