*
* @namespace Events
* @memberOf Cargo
* @extends {Backbone.Events}
*/
/*
* The history object is created in bootstrap
*/
_.extend(Cargo.Event, Backbone.Events);
/**
* Adding history
* Simply push a single URL onto the history stack
* by navigating to that URL
*
* @event add_history
* @memberOf Cargo.Events
*
* @param {string} [url] URL to be added to history
* @param {string} [id] ID of the project (if there is one)
*
* @example Cargo.Event.on("add_history", function(url, id) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("add_history", function( url, id ) {
url = Cargo.Helper.NormalizeRouteLink(url);
// Whenever you are, we're already there
if(url === Cargo.Helper.GetCurrentProjectUrl()){
if( !Cargo.Model.DisplayOptions.GetDisableProjectScroll() ) {
Cargo.Helper.ScrollToTop();
}
return;
}
/* Show the loading animation */
if( !Cargo.Helper.IsCurrentRoute(url) ) {
id = (id) ? id : Cargo.Helper.GetPidFromPurl(url);
Cargo.Helper.ShowLoadingAnimation( id, url );
} else {
/* Scroll to top */
if( !Cargo.Model.DisplayOptions.GetDisableProjectScroll() ) {
Cargo.Helper.ScrollToTop();
}
}
/* Navigate to the new URL */
Cargo.Router.navigate( url, { trigger: true });
});
/**
* Adding history passively
* Change the URL, but don't fire the event
*
* @event add_history_passive
* @memberOf Cargo.Events
* @private
*
* @param {string} [url] URL to be added to history
*
* @example Cargo.Event.on("add_history_passive", function(url) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("add_history_passive", function( url ) {
url = Cargo.Helper.NormalizeRouteLink(url);
/* Navigate to the new URL */
Cargo.Router.navigate( url, { trigger: false });
});
/**
* Page load when editing a project
*
* @memberOf Cargo.Events
*
* @event admin_edit_load_complete
*
* @example Cargo.Event.on("admin_edit_load_complete", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("admin_edit_load_complete", function( ) {
});
/**
* When the audio player is started / stopped
*
* @event audio_play_pause
* @memberOf Cargo.Events
*
* @param {string} [rel] The rel attribute of the button clicked
* @param {string} [which] Which action: play/pause
*
* @example Cargo.Event.on("audio_play_pause", function(rel, which) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("audio_play_pause", function( rel, which ) {
});
/**
* Fires after the columnizer is done updating.
* Note this can be triggered often and repeatedly.
*
* @event columnizer_update_complete
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("columnizer_update_complete", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("columnizer_update_complete", function() {
});
/**
* When on a custom route
*
* @event custom_route_loaded
*
* @memberOf Cargo.Events
*
* @param {string} [location] The route location
*
* @example Cargo.Event.on("custom_route_loaded", function(location) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("custom_route_loaded", function( location ) {
});
/**
* When on a direct link
*
* @event direct_link_loaded
*
* @memberOf Cargo.Events
*
* @param {string} [location] The link loaded
*
* @example Cargo.Event.on("direct_link_loaded", function(location) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("direct_link_loaded", function( location ) {
$(document).trigger("directLinkLoaded", [ location ]);
});
/**
* When the first navigation collection reset event is triggered
*
* @event first_navigation_collection_reset
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("first_navigation_collection_reset", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("first_navigation_collection_reset", function( ) {
});
/**
* When the first project collection reset event is triggered
*
* @event first_project_collection_reset
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("first_project_collection_reset", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("first_project_collection_reset", function( ) {
Cargo.API.Config.first_load_finished = true;
});
/**
* When the fullscreen mode is closed
*
* @event fullscreen_close
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("fullscreen_close", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("fullscreen_close", function( ) {
});
/**
* When the fullscreen mode destroys the hotkeys
* rebind any design keys
*
* @event fullscreen_destroy_hotkeys
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("fullscreen_destroy_hotkeys", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("fullscreen_destroy_hotkeys", function( ) {
Cargo.Core.KeyboardShortcut.Add("Esc", 27, function() {
$("a.follow_popup_cancel").click();
if ( ! $("#freshbox").length > 0 ) {
Cargo.app.Rail.Events.trigger("rail:hide");
}
});
});
/**
* When the fullscreen mode is initialized
*
* @event fullscreen_open
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("fullscreen_open", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("fullscreen_open", function( ) {
});
/**
* When the homepage is loaded
*
* @event homepage_loaded
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("homepage_loaded", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("homepage_loaded", function() {
if(Cargo.View.Navigation) {
Cargo.View.Navigation.AddSetActive();
}
// Scroll the page back to the top
if( !Cargo.Model.DisplayOptions.GetDisableProjectScroll() ) {
Cargo.Helper.ScrollToTop();
}
});
/**
* When the inspector is unloaded
*
* @event inspector_unload
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("inspector_unload", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("inspector_unload", function( ) {
// Rebind all of the objects again
Cargo.Collection.Projects.reset( Cargo.Collection.Projects.models );
Cargo.Event.Common();
});
/**
* When a the loading animations have been replaced
*
* @event loading_anims_replaced
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("loading_anims_replaced", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("loading_anims_replaced", function( ) {
});
/**
* When the freshbox launches
*
* @event lightbox_open
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("lightbox_open", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("lightbox_open", function( ) {
});
/**
* When the freshbox is all done
*
* @event lightbox_close
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("lightbox_close", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("lightbox_close", function( ) {
});
/**
* When the navigation content has been reset with a new model
*
* @event navigation_reset
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("navigation_reset", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("navigation_reset", function() {
});
/**
* When the lightbox has been created and is ready in the window
* Triggered by proxying photoswipe events
*
* @event lightbox-init
*
* @param {object} [lightbox] The photoswipe instance
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("lightbox-init", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on('lightbox-init', function(lightbox){
// hack to prevent lightbox from janking on iOS's slow resize
if( Cargo.Helper.isMobile()) {
var resizeTimeout
$(window).on('resize.lightbox', function(){
clearTimeout(resizeTimeout);
resizeTimeout = setTimeout(function(){
lightbox.updateSize(true);
}, 500);
})
}
});
/**
* When the lightbox has been destroyed
* Triggered by proxying photoswipe events
*
* @event lightbox-destroy
*
* @param {object} [lightbox] The photoswipe instance
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("lightbox-init", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on('lightbox-destroy', function(lightbox){
if( Cargo.Helper.isMobile()) {
$(window).off('resize.lightbox');
}
});
/**
* When a set in the navigation is being opened or closed
*
* @event navigation_set_toggle
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("navigation_set_toggle", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("navigation_set_toggle", function() {
});
/**
* Go to the next page
*
* @event next_page
*
* @memberOf Cargo.Events
*
* @param {number} [page] Page number
*
* @example Cargo.Event.on("next_page", function(page) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("next_page", function( new_page ) {
$(document).trigger("pageChange", [new_page]);
});
/**
* Go to the next project
*
* @event next_project
*
* @memberOf Cargo.Events
*
* @param {number} [pid] PID of the project to be loaded
*
* @example Cargo.Event.on("next_project", function(pid) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("next_project", function( pid ) {
$(document).trigger("showNextProject", [pid]);
});
/**
* When the pagination is done
*
* @event pagination_complete
*
* @memberOf Cargo.Events
*
* @param {number} [page] Page number of the newly loaded page
*
* @example Cargo.Event.on("pagination_complete", function(page) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("pagination_complete", function( new_page ) {
$(document).trigger("pageChangeComplete", [new_page] );
$(document).trigger("paginationComplete", [new_page] );
Cargo.Helper.HideLoadingAnimation();
// Common events that are fired multiple times
Cargo.Event.Common();
/* Add an active state to the navigation */
if(Cargo.View.Navigation) {
Cargo.View.Navigation.AddActive();
Cargo.View.Navigation.AddSetActive();
}
/* Add an active state to the thumbnail */
if(Cargo.View.Thumbnail) {
Cargo.View.Thumbnail.AddActive();
}
});
/**
* When the pagination starts
*
* @event pagination_start
*
* @memberOf Cargo.Events
*
* @param {number} [page] Page number of the page to be loaded
*
* @example Cargo.Event.on("pagination_start", function(page) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("pagination_start", function( new_page ) {
Cargo.Helper.ShowLoadingAnimation();
});
/**
* Go to the previous page
*
* @event prev_page
*
* @memberOf Cargo.Events
*
* @param {number} [page] Page number to go back to
*
* @example Cargo.Event.on("prev_page", function(page) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("prev_page", function( new_page ) {
$(document).trigger("pageChange", [new_page]);
});
/**
* Go to the previous project
*
* @event prev_project
*
* @memberOf Cargo.Events
*
* @param {number} [pid] PID of the previous project
*
* @example Cargo.Event.on("prev_project", function(pid) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("prev_project", function( pid ) {
$(document).trigger("showPrevProject", [pid]);
});
/**
* Fires whenever a project is closing, either to the index or another page/project
*
* @event project_change
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("project_change", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("project_change", function() {
});
/**
* When a the project collection has loaded
*
* @event project_collection_reset
*
* @memberOf Cargo.Events
*
* @example Cargo.Event.on("project_collection_reset", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("project_collection_reset", function( ) {
});
/**
* When the a project is finished loading
*
* @event project_load_complete
*
* @memberOf Cargo.Events
*
* @param {number} [pid] PID of the project to be loaded
*
* @example Cargo.Event.on("project_load_complete", function(pid) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("project_load_complete", function( pid ) {
$(document).trigger("projectLoadComplete", [ pid ]);
/* Reset the Project Transition */
Cargo.Event.ProjectTransition = new $.Deferred();
/* Common events that are fired multiple times */
Cargo.Event.Common();
/* Scroll the page back to the top */
if( !Cargo.Model.DisplayOptions.GetDisableProjectScroll() ) {
Cargo.Helper.ScrollToTop();
}
/* Change the bg color, if needed */
if(Cargo.View.ProjectDetail) {
Cargo.View.ProjectDetail.ChangeBgColorFromModel();
}
/* Remove the set class from body */
if(Cargo.View.Main && !Cargo.Helper.IsOnStartProject()) {
Cargo.View.Main.RemoveStartProjectClass();
}
/* Add an active state to the navigation */
if(Cargo.View.Navigation) {
Cargo.View.Navigation.AddActive(pid);
Cargo.View.Navigation.AddSetActive();
}
/* Add an active state to the thumbnail */
if(Cargo.View.Thumbnail) {
Cargo.View.Thumbnail.AddActive(pid);
Cargo.View.Thumbnail.CheckAndHideThumbs();
}
/* Hide the loading animations */
Cargo.Helper.HideLoadingAnimation();
/* Set the html page title */
if( !Cargo.Helper.IsOnStartProject() ) {
Cargo.View.Main.SetWindowTitle();
}
/* Set the data-type on the body */
Cargo.View.Main.SetDataType(Cargo.Model.Project.GetType());
// Gracefully track project load as a pageview
if (! Cargo.API.Config.is_direct_link && ! Cargo.Helper.IsOnStartProject()) {
Cargo.Analytics.pageview(true);
}
});
/**
* When a project starts to load
*
* @event project_load_start
*
* @memberOf Cargo.Events
*
* @param {string} [purl] Project URL about to be loaded
*
* @example Cargo.Event.on("project_load_start", function(purl) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("project_load_start", function( purl ) {
Cargo.Event.trigger('project_change');
$(document).trigger("startProjectLoaded", [purl]);
// Set is_direct_link to false once we start loading our projects through JS
Cargo.API.Config.is_direct_link = false;
});
/**
* Go to a random project
*
* @event random_project
*
* @memberOf Cargo.Events
*
* @param {number} [pid] PID of a random project to be loaded
*
* @example Cargo.Event.on("random_project", function(pid) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("random_project", function( pid ) {
$(document).trigger("showRandomProject", [pid]);
});
/**
* Triggered once the navigation reseed is complete
* Reseeding happens when the admin refreshes the front end via frame
*
* @event reseed_navigation_complete
*
* @memberOf Cargo.Events
*
*
* @example Cargo.Event.on("reseed_navigation_complete", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("reseed_navigation_complete", function( pid ) {
});
/**
* Triggered once the project reseed is complete
* Reseeding happens when the admin refreshes the front end via frame
*
* @event reseed_project_complete
*
* @memberOf Cargo.Events
*
*
* @example Cargo.Event.on("reseed_project_complete", function() {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("reseed_project_complete", function( pid ) {
});
/**
* When on a set
*
* @event set_loaded
*
* @memberOf Cargo.Events
*
* @param {string} [location] The URL of the set
*
* @example Cargo.Event.on("set_loaded", function(location) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("set_loaded", function( location ) {
});
/**
* When a the index is completely loaded (project is closed)
*
* @event show_index_complete
*
* @memberOf Cargo.Events
*
* @param {number} [pid] PID of the project recently closed
*
* @example Cargo.Event.on("show_index_complete", function(pid) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("show_index_complete", function( pid ) {
$(document).trigger("projectCloseComplete", [pid]);
$(document).trigger("projectIndex");
/* Remove active state to the navigation */
if(Cargo.View.Navigation) {
Cargo.View.Navigation.RemoveActive();
}
/* Remove active state to the thumbnails */
if(Cargo.View.Thumbnail) {
Cargo.View.Thumbnail.RemoveActive();
Cargo.View.Thumbnail.ShowThumbs();
}
/* Set the html page title */
Cargo.View.Main.SetWindowTitle(true);
/* Remove the data-type on the body */
Cargo.View.Main.SetDataType(null);
/* Remove the start project class */
Cargo.View.Main.RemoveStartProjectClass();
/* Reset the Project Transition */
Cargo.Event.IndexTransition = new $.Deferred();
});
/**
* When the index is about to be shown (project is about to close)
*
* @event show_index_start
*
* @memberOf Cargo.Events
*
* @param {number} [pid] PID of the project currently open
*
* @example Cargo.Event.on("show_index_start", function(pid) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("show_index_start", function( pid ) {
Cargo.Event.trigger('project_change')
$(document).trigger("projectClose", [pid]);
});
/**
* Slideshow is resizing
*
* @event slideshow_resize
*
* @memberOf Cargo.Events
*
* @param {object} [el] Slideshow Element
* @param {object} [obj] The slideshow instance
*
* @example Cargo.Event.on("slideshow_resize", function(el, obj) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("slideshow_resize", function( el, obj ) {
});
/**
* Slideshow transition is starting
*
* @event slideshow_transition_start
*
* @memberOf Cargo.Events
*
* @param {object} [el] Slideshow Element
* @param {object} [obj] The slideshow instance
*
* @example Cargo.Event.on("slideshow_transition_start", function(el, obj) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("slideshow_transition_start", function( el, obj ) {
$(document).trigger("slideshowTransitionStart");
});
/**
* Slideshow transition is finished
*
* @event slideshow_transition_finish
*
* @memberOf Cargo.Events
*
* @param {object} [el] Slideshow Element
* @param {object} [obj] The slideshow instance
*
* @example Cargo.Event.on("slideshow_transition_finish", function(el, obj) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("slideshow_transition_finish", function( el, obj ) {
$(document).trigger("slideshowTransitionFinish");
});
/**
* When on a solo link
*
* @event solo_link_loaded
*
* @memberOf Cargo.Events
*
* @param {string} [location] URL of the link loaded
*
* @example Cargo.Event.on("solo_link_loaded", function(location) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("solo_link_loaded", function( location ) {
});
/**
* When a template has been loaded
*
* @event template_loaded
*
* @memberOf Cargo.Events
*
* @param {string} [template] Name of the template loaded
*
* @example Cargo.Event.on("template_loaded", function(template) {
* // Methods after event is triggered
*});
*/
Cargo.Event.on("template_loaded", function( template_name ) {
});
/**
* Common events that are fired regularly
*
* @method common
* @private
*
* @memberOf Cargo.Events
*/
Cargo.Event.Common = function() {
/* Check for, and activate, slideshows */
if(typeof Cargo.Core.Slideshow.InitSlideshow != "undefined") {
Cargo.Core.Slideshow.InitSlideshow();
}
/* Check for, and activate, video fallback */
Cargo.Core.Video.CheckForVideo();
/* Find an init any audio players */
Cargo.Core.Audio.CheckForAudio();
/* Look for a search form in a project or on the page */
Cargo.Core.FindAndLoadSearch();
/* Check and init freshbox, but only on non-permalink */
if( !Cargo.Helper.IsPermalink( Cargo.Model.Project.GetProjectUrl() ) ) {
Cargo.Core.CheckAndInitFreshbox();
}
/* Remove the freshbox */
if( $("#freshbox").length > 0) {
Cargo.View.Fullscreen.Close();
}
}
/***************************************************************************
*
* Project transition event
*
**************************************************************************/
/**
* A global for holding a jquery Deferred object
* This is used for project and index transitions
*
* @type {jQuery}
* @method common
* @private
*
* @memberOf Cargo.Events
*/
Cargo.Event.ProjectTransition = new $.Deferred();
Cargo.Event.IndexTransition = new $.Deferred();
/**
* A global method that is meant to be overwritten by designs
* This is a method that will run while transitioning a project open
* The project opening is deferred until this method resolves itself.
*
* @param {String} pid The project ID
* @param {String} project_markup The rendered HTML for the requested project
* @param {Object} project_model The full project model
* @method common
* @private
*
* @memberOf Cargo.Events
*/
Cargo.Event.ShowProjectTransition = function(pid, project_markup, project_model) {
Cargo.Event.ProjectTransition.resolve();
return Cargo.Event.ProjectTransition.promise();
}
/**
* A global method that is meant to be overwritten by designs
* This is a method that will run while transitioning a project close / show index
* The index showing is deferred until this method resolves itself.
*
* @param {String} pid The project ID being closed
* @param {Object} project_model The full project model
* @method common
* @private
*
* @memberOf Cargo.Events
*/
Cargo.Event.ShowIndexTransition = function(pid, project_model) {
Cargo.Event.IndexTransition.resolve();
return Cargo.Event.IndexTransition.promise();
}
/***************************************************************************
*
* jQuery Events
*
**************************************************************************/
/*
* This is the close event from Cargo 1.0
* When triggered, it will close a project
* For now, this remains in this file. Probably should move it
*/
$(document).bind("closeProject", function(e) {
Action.Project.Close();
});
/***************************************************************************
*
* Helpers
* This contains various helper methods that are used
* in various views
*
**************************************************************************/
/**
* The Cargo namespace holds all fields and methods
* @namespace Cargo
*/
/**
* @namespace o
* @memberOf Cargo
*/
/**
* @constructor Cargo.o.Helpers
* @extends {Backbone.View}
* @memberOf Cargo.o
*/
Cargo.o.helpers = Backbone.View.extend({
Data : {
is_loading : false,
loading_timout : 1000
},
/**
* Checks to see if the browser allows fullscreen
*
* @public
*
* @memberOf Cargo.o.Helpers
*
* @return {boolean} True if fullscreen is supported, false if not.
* @example Cargo.Helper.AllowsFullScreen();
*/
AllowsFullScreen : function() {
var docElem = document.documentElement;
if (docElem.requestFullscreen || docElem.mozRequestFullScreen || docElem.msRequestFullscreen || docElem.webkitRequestFullScreen) {
return true;
} else {
return false;
}
},
/**
* Find Project Collection based on Project URL
*
* @public
* @memberOf Cargo.o.Helpers
*
* @param {String} [project_url] URL of the Project
*
* @return {object} Project collection
* @example Cargo.Helper.FindCollectionByProjectUrl(url);
*/
FindCollectionByProjectUrl : function( project_url ) {
var found_collection = false;
_.each(Cargo.Collection.Page, function(collection) {
if( !found_collection ) {
var dummy_collection = new Backbone.Collection();
dummy_collection.reset(collection);
var model = dummy_collection.where( { project_url : project_url } );
if(model[0]) {
found_collection = collection;
}
}
});
return found_collection;
},
/**
* Get the active Filter
*
* @memberof Cargo.o.Helpers
*
* @return {string} Filter name
* @example Cargo.Helper.GetActiveFilter();
*/
GetActiveFilter : function() {
return Cargo.API.Config.filter;
},
/**
* Get the active index. This will return
* /url/filter/cat OR /url/set OR /url
* Whatever the current page's index is
*
* @memberof Cargo.o.Helpers
*
* @param {Boolean} [full_path] Returns the full http://domain.com/path or http://cargocollective.com/url/path
* @return {string} Index path
* @example Cargo.Helper.GetActiveIndex();
*/
GetActiveIndex : function(full_path) {
var relative_path = Cargo.Helper.GetHomeUrl(true, true);
return (full_path) ? window.location.protocol + '//'+this.GetBaseDomain()+relative_path : relative_path;
},
/**
* This is a way to load backbone collections, models and views
* without knowing the case. It is useful because of the data-view attributes
* that do all the dynamic loading on each page
*
* @public
* @memberof Cargo.o.Helpers
*
* @param {object} [obj] backbone object
* @param {string} [model] Name of the requested model
*
* @return {string} Name actual name of the model
* @example Cargo.Helper.GetBackboneCaseInsensitive(obj, model);
*/
GetBackboneCaseInsensitive : function(obj, requested_model) {
var mapped_methods = {};
for(var f in obj){
// console.log(f+" -- "+obj.hasOwnProperty(f)+" -- "+typeof obj[f]);
if(obj.hasOwnProperty(f) && (typeof obj[f]=='function' || typeof obj[f]=='object')){
mapped_methods[f.toLowerCase()] = f;
}
}
return (requested_model) ? mapped_methods[requested_model.toLowerCase()] : "";
},
/**
* Get the base URL
*
* @public
* @memberof Cargo.o.Helpers
*
* @param {boolean} [force] Always return the Cargo/url
* @param {boolean} [add_slash] If a slash should be returned with Cargo/url
*
* @return {string} If custom domain, return nothing, otherwise return Cargo/url
* @example Cargo.Helper.GetBaseUrl(force, add_slash);
*/
GetBaseUrl : function(force_url, add_slash) {
if( Cargo.API.Config.is_domain ) {
return (add_slash) ? "/" : "";
} else {
var url = (force_url) ? Cargo.API.Config.cargo_url : "";
return (add_slash) ? "/" + url : url;
}
},
/**
* The base Cargo domain
*
* @memberof Cargo.o.Helpers
*
* @return {string} The Cargo root domain
* @example Cargo.Helper.GetBaseCargoDomain();
*/
GetBaseCargoDomain : function() {
return (/cargocollective.com/.test(document.location.host) || /persona.co/.test(document.location.host)) ? document.location.host : 'cargocollective.com';
},
/**
* The base domain
*
* @memberof Cargo.o.Helpers
*
* @return {string} The active root domain
* @example Cargo.Helper.GetBaseDomain();
*/
GetBaseDomain : function() {
return (/cargocollective.com/.test(document.location.host)) ? 'cargocollective.com' : document.location.host;
},
/**
* Gets the current model from the Project collection
*
* @memberof Cargo.o.Helpers
*
* @return {object} The active Project Model
* @example Cargo.Helper.GetCurrentModelFromProjects();
*/
GetCurrentModelFromProjects : function() {
return Cargo.Collection.Projects.where( { project_url : Cargo.Helper.GetCurrentProjectUrl() } );
},
/**
* Get the open Project or Page's type
*
* @memberof Cargo.o.Helpers
*
* @return {string/boolean} String of "page" or "project" or false
* @example Cargo.Helper.GetCurrentPageType();
*/
GetCurrentPageType : function() {
return Cargo.Model.Project.GetType();
},
/**
* Get the open Project's URL
*
* @memberof Cargo.o.Helpers
*
* @return {string/boolean} String of URL or false
* @example Cargo.Helper.GetCurrentProjectUrl();
*/
GetCurrentProjectUrl : function() {
return Cargo.Model.Project.GetProjectUrl();
},
/**
* Get the open project's ID
*
* @memberof Cargo.o.Helpers
*
* @return {string/boolean} String of ID or false
* @example Cargo.Helper.GetCurrentProjectId();
*/
GetCurrentProjectId : function() {
return Cargo.Model.Project.GetId();
},
/**
* Get the current Backbone route
*
* @memberof Cargo.o.Helpers
*
* @return {string} Route name
* @example Cargo.Helper.GetCurrentRoute();
*/
GetCurrentRoute : function() {
return Backbone.history.fragment;
},
/**
* Gets the name of the Design
*
* @memberof Cargo.o.Helpers
*
* @return {string} Design name
* @example Cargo.Helper.GetDesignName();
*/
GetDesignName : function() {
return Cargo.API.Config.design_name;
},
/**
* Get the domain or the Cargo/url
*
* @memberof Cargo.o.Helpers
*
* @return {string} Domain or URL
* @example Cargo.Helper.GetDomainOrUrl();
*/
GetDomainOrUrl : function() {
if( Cargo.API.Config.is_domain ) {
return this.GetUrl();
} else {
return location.pathname.split("/")[1];
}
},
/**
* Gets the homepage URL
* Could be Filter, could be search, could be domain. etc
*
* @memberof Cargo.o.Helpers
*
* @param {boolean} [force] Force return of the Cargo/url
* @param {boolean} [add_slash] Prefix a slash to the result
*
* @return {string} URL
* @example Cargo.Helper.GetHomeUrl(force, add_slash);
*/
GetHomeUrl : function(force_url, add_slash) {
var slash = (add_slash) ? "/" : "";
// Set and Filter
if( Cargo.API.Config.set && Cargo.API.Config.filter) {
if( Cargo.API.Config.is_domain ) {
return slash + Cargo.API.Config.set + "/filter/" + encodeURIComponent(Cargo.API.Config.filter);
} else {
return this.GetBaseUrl(force_url, add_slash) + "/" + Cargo.API.Config.set + "/filter/" + encodeURIComponent(Cargo.API.Config.filter);
}
}
// Route and Filter
else if( Cargo.API.Config.route && Cargo.API.Config.filter) {
if( Cargo.API.Config.is_domain ) {
return Cargo.Helper.GetRouteUrl() + "/filter/" + encodeURIComponent(Cargo.API.Config.filter);
} else {
return this.GetBaseUrl(force_url, false) + Cargo.Helper.GetRouteUrl() + "/filter/" + encodeURIComponent(Cargo.API.Config.filter);
}
}
// Filter only
else if( Cargo.API.Config.filter ) {
if( Cargo.API.Config.is_domain ) {
return slash + "filter/" + encodeURIComponent(Cargo.API.Config.filter);
} else {
return this.GetBaseUrl(force_url, add_slash) + "/filter/" + encodeURIComponent(Cargo.API.Config.filter);
}
}
// Set only
else if( Cargo.API.Config.set ) {
if( Cargo.API.Config.is_domain ) {
return slash + Cargo.API.Config.set;
} else {
return this.GetBaseUrl(force_url, add_slash) + "/" + Cargo.API.Config.set;
}
}
// Route only
else if( Cargo.API.Config.route ) {
if( Cargo.API.Config.is_domain ) {
return Cargo.Helper.GetRouteUrl();
} else {
// Note: don't send the route with the base because we don't want to load projects
// inside of routes. The projects will redirect to the actual links instead
return this.GetBaseUrl(force_url, add_slash); // + "/" + Cargo.Helper.GetRouteUrl();
}
}
// Default
else {
return this.GetBaseUrl(force_url, add_slash);
}
},
/**
* Gets the index from one model from the Project collection
* Returns the index
*
* @memberof Cargo.o.Helpers
*
* @param {Backbone.Model} [model] Backbone model
* @return {number} Index of the model
* @example Cargo.Helper.GetIndexFromModel(model);
*/
GetIndexFromModel : function( model ) {
return Cargo.Collection.Projects.indexOf(model[0]);
},
/**
* Grabs the value of the editor
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.GetIsEditor();
*/
GetIsEditor : function() {
return Cargo.API.Config.is_editor;
},
/**
* returns the next page offset
* Calculates this based on the page * limit
*
* @memberof Cargo.o.Helpers
* @return {number} Offset
* @example Cargo.Helper.GetNextPageOffset();
*/
GetNextPageOffset : function() {
var limit = this.GetPageLimit();
var page = Cargo.API.Config.current_page;
return (page*limit);
},
/**
* This returns a new Backbone model of the next Project
* It is a convenience method
*
* @memberof Cargo.o.Helpers
* @return {Backbone.Model} Project model
* @example Cargo.Helper.GetNextProjectModel();
*/
GetNextProjectModel : function() {
return Cargo.Collection.Projects.findWhere( { project_url : Cargo.Helper.GetNextProjectUrl() } );
},
/**
* Returns the next Project's purl
* Note: Will wrap the collection back to 0
*
* @memberof Cargo.o.Helpers
* @return {string} URL
* @example Cargo.Helper.GetNextProjectUrl();
*/
GetNextProjectUrl : function() {
var model = this.GetCurrentModelFromProjects();
var index = this.GetIndexFromModel( model );
var next_index = (index+1) % Cargo.Collection.Projects.length;
var next_model = Cargo.Collection.Projects.at(next_index);
return next_model.get('project_url');
},
/**
* Calculates the page offset based on page
* Subtract 1 from the page because the offset starts from 0
* but page starts from 1
*
* @memberof Cargo.o.Helpers
* @return {number} Offset
* @example Cargo.Helper.GetOffsetFromPage();
*/
GetOffsetFromPage : function( page ) {
var limit = this.GetPageLimit();
page--;
return (page*limit);
},
/**
* Gets the limit of Projects per page
* Note, when there is an Index page (like Feed) this might be different.
*
* @memberof Cargo.o.Helpers
* @return {number} Page limit
* @example Cargo.Helper.GetPageLimit();
*/
GetPageLimit : function() {
var option_limit = Cargo.Model.DisplayOptions.GetPaginationCount();
if(
option_limit &&
Cargo.Model.DisplayOptions.GetIndexRouteName() &&
Cargo.Model.DisplayOptions.GetIndexRouteName().toUpperCase() == Cargo.Helper.GetRouteName().toUpperCase() &&
Cargo.Model.DisplayOptions.get('index_pagination_count')
) {
option_limit = Cargo.Model.DisplayOptions.get('index_pagination_count');
} else if(Cargo.Model.DisplayOptions.get('mobile_pagination_count') && this.isMobile()) {
option_limit = Cargo.Model.DisplayOptions.get('mobile_pagination_count');
}
return (option_limit) ? option_limit : 10;
},
/**
* Return the id from the model based on purl
*
* @memberof Cargo.o.Helpers
* @param {string} [purl] URL for the project
* @return {number} Project ID
* @example Cargo.Helper.GetPidFromPurl(purl);
*/
GetPidFromPurl : function( project_url ) {
// Set the new model
var model = Cargo.Collection.Projects.where( { project_url : project_url } );
if(model[0]) {
return model[0].get('id');
} else {
return 0;
}
},
/**
* Calculates previous page offset
*
* @memberof Cargo.o.Helpers
* @return {number} Offset
* @example Cargo.Helper.GetPrevPageOffset();
*/
GetPrevPageOffset : function() {
var limit = this.GetPageLimit();
var page = Cargo.API.Config.current_page-1;
return (page*limit);
},
/**
* This returns a new backbone model of the previous project
* It is a convenience method
*
* @memberof Cargo.o.Helpers
* @return {Backbone.Model} Project model
* @example Cargo.Helper.GetPrevProjectModel();
*/
GetPrevProjectModel : function() {
return Cargo.Collection.Projects.findWhere( { project_url : Cargo.Helper.GetPrevProjectUrl() } );
},
/**
* The url for the previous Project
*
* @memberof Cargo.o.Helpers
* @return {string} URL
* @example Cargo.Helper.GetPrevProjectUrl();
*/
GetPrevProjectUrl : function() {
var model = this.GetCurrentModelFromProjects();
var index = this.GetIndexFromModel( model );
var next_index = (index > 0) ? index-1 : Cargo.Collection.Projects.length - 1;
var next_model = Cargo.Collection.Projects.at(next_index);
return next_model.get('project_url');
},
/**
* Returns a page and a single backbone model based on key
* This takes into account the possibility that the model
* exists in a different page then the current one
*
* @memberof Cargo.o.Helpers
* @return {Object} { "page" : 3, "model" : [Object] }
* @example Cargo.Helper.GetProjectModelAndPageByKey(key);
*/
GetProjectModelAndPageByKey : function( key ) {
var offset = this.GetPageLimit();
var current_page = Cargo.API.Config.current_page;
var page = Math.ceil(key/offset);
var page_offset = 0;
if( !Cargo.Helper.IsAutopaginate() ) {
page_offset = offset - ((page * offset) - key);
page_offset = (page_offset == offset) ? page_offset-1 : page_offset;
page_offset = (page_offset == Cargo.Collection.Projects.length) ? 0 : page_offset;
} else {
page = 0;
page_offset = (key == Cargo.Collection.Projects.length) ? 0 : key;
}
var model = {};
// Grab from collection ahead of page 1
if(Cargo.Collection.Page[page] && !Cargo.Helper.IsAutopaginate() ) {
model = new Cargo.Model.BaseProject( Cargo.Collection.Page[page][page_offset] );
}
// Grab from the active collection
else {
model = Cargo.Collection.Projects.at(page_offset);
}
return {
"page" : page,
"model" : model
}
},
/**
* Return the purl from the model based on pid
*
* @memberof Cargo.o.Helpers
* @param {number} [pid] Project ID
* @return {string} Project URL
* @example Cargo.Helper.GetPurlFromPid(pid);
*/
GetPurlFromPid : function( id ) {
// Set the new model
var model = Cargo.Collection.Projects.where( { id : id } );
if(model[0]) {
return model[0].get('project_url');
} else {
return 0;
}
},
/**
* Get the route name
*
* @memberof Cargo.o.Helpers
*
* @return {string} Route name
* @example Cargo.Helper.GetRouteName();
*/
GetRouteName : function() {
var route_name = Cargo.API.Config.route_name;
if(/display_options/.test(Cargo.API.Config.route)) {
route_name = (/feed/.test(route_name)) ? Cargo.Model.DisplayOptions.GetFeedRouteName() : Cargo.Model.DisplayOptions.GetIndexRouteName();
}
return route_name;
},
/**
* Get the route url
*
* @memberof Cargo.o.Helpers
*
* @return {string} Route name
* @example Cargo.Helper.GetRouteUrl();
*/
GetRouteUrl : function() {
var route_url = Cargo.API.Config.route_name;
if(/display_options/.test(Cargo.API.Config.route) || route_url == "feed" || route_url == "index") {
route_url = (/feed/.test(route_url)) ? Cargo.Model.DisplayOptions.GetFeedRouteUrl() : Cargo.Model.DisplayOptions.GetIndexRouteUrl();
}
return route_url;
},
/**
* Get the currently active set key
*
* @memberof Cargo.o.Helpers
* @return {string} Current set key
* @example Cargo.Helper.GetCurrentSetKey();
*/
GetSetKey : function() {
return Cargo.Model.Site.GetCurrentSetKey();
},
/**
* Returns the name of the current set
*
* @memberof Cargo.o.Helpers
* @return {string} Set name
* @example Cargo.Helper.GetSetName();
*/
GetSetName : function() {
return Cargo.API.Config.set;
},
/**
* Returns the start project id
*
* @memberof Cargo.o.Helpers
* @return {number} Start Project ID
* @example Cargo.Helper.GetStartProjectId();
*/
GetStartProjectId : function() {
return Math.floor(Cargo.Model.Site.GetStartProjectId());
},
/**
* Get the total amount of pages
*
* @memberof Cargo.o.Helpers
* @return {number} Total pages
* @example Cargo.Helper.GetTotalPages();
*/
GetTotalPages : function() {
return Math.ceil( Cargo.Model.DisplayOptions.GetTotalProjects() / Cargo.Helper.GetPageLimit() );
},
/**
* Get the total amount of Projects in memory (used for random)
*
* @memberof Cargo.o.Helpers
* @return {number} Total projects in memory
* @example Cargo.Helper.GetTotalProjectsInMemory();
*/
GetTotalProjectsInMemory : function() {
var current_count = Cargo.Collection.Projects.length;
if( Cargo.Helper.IsAutopaginate() ) {
return current_count;
}
var stored_count = 0;
$.each(Cargo.Collection.Page, function() { stored_count += this.length; });
return current_count + stored_count;
},
/**
* Get the Cargo/url
*
* @memberof Cargo.o.Helpers
* @return {string} This site's Cargo/url
* @example Cargo.Helper.GetUrl();
*/
GetUrl : function() {
// return location.pathname.replace(/^\/([^\/]*).*$/, '$1');
return Cargo.API.Config.cargo_url;
},
/**
* Go to a URL on this site. Does a full page refresh
*
* @memberof Cargo.o.Helpers
* @param {String} [relative_path] The relative path of the URL
* @example Cargo.Helper.GoToUrl("filter/category");
*/
GoToUrl : function(relative_path) {
relative_path = (relative_path.charAt(0) == "/") ? relative_path.substr(1) : relative_path;
var baseurl = Cargo.Helper.GetBaseUrl(true, true);
var location_path = (Cargo.API.Config.is_domain) ? baseurl + relative_path : baseurl + "/" + relative_path;
top.document.location.href = location_path;
},
/**
* Hides the loading animation
* Fires an event
* Use with:
*
*
* @memberof Cargo.o.Helpers
* @param {number} [pid] Project ID
* @example Cargo.Helper.HideLoadingAnimation(pid);
*/
HideLoadingAnimation : function( pid ) {
this.Data.is_loading = false;
$("[data-loading]").hide();
if(typeof Cargo.View.Autopaginate == "object") {
Cargo.View.Autopaginate.$el.hide();
}
},
/**
* Checks to see if we are in Admin edit mode
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsAdminEdit();
*/
IsAdminEdit : function() {
var is_admin_path = (/\/adminedit/.test(document.location.pathname) || /\/admin/.test(document.location.pathname));
var has_parent = (parent.location != window.location);
return (is_admin_path || has_parent);
},
/**
* Checks to see if we are in aAdmin edit mode
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsAdminEditProject();
*/
IsAdminEditProject : function() {
return Cargo.API.Config.admin_edit_project;
},
/**
* Checks to see if this Design autopaginates
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsAutopaginate();
*/
IsAutopaginate : function() {
return ( Cargo.View.Autopaginate || $("[data-view='Autopaginate']").length > 0 || $("[data-view='autopaginate']").length > 0);
},
/**
* Matches an incoming route with the current route
* Used to ensure we are not trying to double load
*
* @memberof Cargo.o.Helpers
* @param {string} [url] URL
* @return {boolean}
* @example Cargo.Helper.IsCurrentRoute(url);
*/
IsCurrentRoute : function( url ) {
// Normalize the url
url = this.NormalizeRouteLink(url);
// Now compare
return (Cargo.Helper.GetCurrentRoute() == url);
},
/**
* If we are currently on a custom defined route
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsCustomRoute();
*/
IsCustomRoute : function() {
return Cargo.API.Config.is_custom_route;
},
/**
* If we are currently on a Direct Link
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsDirectLink();
*/
IsDirectLink : function() {
return Cargo.API.Config.is_direct_link;
},
/**
* If this is a design without Project history
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsFeedDesign();
*/
IsFeedDesign : function() {
return ($("[rel='history']").length == 0) ? true : false;
},
/**
* If we are currently on a filter link
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsFilter();
*/
IsFilter : function() {
return (this.GetActiveFilter() && this.GetActiveFilter().trim() != "");
},
/**
* Test for Firefox. Return true | false
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isFirefox();
*/
isFirefox : function() {
return (/Firefox\/\d+\.\d+/.test(navigator.userAgent));
},
/**
* Test for IE. Return true | false
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isIE();
*/
isIE : function() {
return (/MSIE (\d+\.\d+);/.test(navigator.userAgent));
},
/**
* Test for IE8. Return true | false
* Actually, this is just a test for anything < 9
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isIE8();
*/
isIE8 : function() {
var rv = -1; // Return value assumes failure.
if (this.isIE()) {
var re = new RegExp("MSIE ([0-9]{1,}[\.0-9]{0,})");
if (re.exec(navigator.userAgent) != null) rv = parseFloat( RegExp.$1 );
}
return (rv < 9 && rv > 0) ? true : false;
},
/**
* Test for iOS.
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isIOS();
*/
isIOS : function() {
if (navigator.userAgent.match(/i(Phone|Pod|Pad)/i)) {
return true;
} else {
return false;
}
},
/**
* Test for all mobile.
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isMobile();
*/
isMobile : function() {
if(this.isIOS()) return true
else {
var check = false;
(function(a){if(/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i.test(a)||/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(a.substr(0,4)))check = true})(navigator.userAgent||navigator.vendor||window.opera);
return check;
}
},
/**
* If we are currently on the homepage
*
* @memberOf Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsOnHome();
*/
IsOnHome : function() {
var on_home = (Cargo.API.Config.set || Cargo.API.Config.filter || Cargo.Helper.GetCurrentRoute() != "") ? false : true;
return on_home;
},
/**
* If we are currently on a set
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsOnSet();
*/
IsOnSet : function() {
return (Cargo.API.Config.set) ? true : false;
},
/**
* If we are currently on a start project
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsOnStartProject();
*/
IsOnStartProject : function() {
return (Cargo.Helper.GetCurrentRoute() == "" && Cargo.API.Config.start_project != null);
},
/**
* Test for anything less then IE10
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isOldIE();
*/
isOldIE : function() {
var rv = -1; // Return value assumes failure.
if (this.isIE()) {
var re = new RegExp("MSIE ([0-9]{1,}[\.0-9]{0,})");
if (re.exec(navigator.userAgent) != null) rv = parseFloat( RegExp.$1 );
}
return (rv <= 9 && rv > 0) ? true : false;
},
/**
* Called by the router
* This method tests to see if a given route is a permalink
* (loaded by direct link) or if it is loaded by a click
* To determine this, see if the collection data has been loaded yet
* If it has, then this is not a permalink
*
* @memberof Cargo.o.Helpers
* @param {string} [purl] Project URL
* @param {boolean} [from_router] If we are coming from the router or not
* @return {boolean}
* @example Cargo.Helper.IsPermalink(purl, from_router);
*/
IsPermalink : function( purl, from_router ) {
var project_or_route = false;
var start_and_no_project = false;
var collection_loaded = false;
var strip_url = (this.GetRouteUrl()) ? this.GetRouteUrl().replace(/\//,'') : '';
// If the incoming PURL is a project or route
if(
this.IsCurrentProject(purl) ||
this.IsCurrentProjectId(purl) ||
this.IsCurrentRoute(purl) ||
strip_url == purl ||
Cargo.Helper.GetRouteName() == strip_url ||
purl == "Website-Offline-message"
) {
project_or_route = true;
}
// If this is a start project
if(
Cargo.Helper.IsOnStartProject() &&
Cargo.Model.Project.GetProjectUrl() != purl
) {
start_and_no_project = true;
}
// If the collection has been loaded from the server yet
if(
Cargo.Collection.Projects.models.length >= 1 &&
Cargo.Collection.Projects.models[0].id
) {
collection_loaded = true;
}
var project_is_project = (Cargo.Model.Project.GetProjectUrl() == purl || Cargo.Model.Project.GetId() == purl || this.GetRouteName() == purl || this.GetCurrentRoute() == purl || purl == "Website-Offline-message");
var start_and_no_project = (Cargo.Helper.IsOnStartProject() && Cargo.Model.Project.GetProjectUrl() != purl);
var _final = (!Cargo.API.Config.first_load_finished && (project_is_project || start_and_no_project) );
/*
* NOTE: If there are issues, it is because of this. Comment the conditional(s) below out to fix
*/
var _final_new = (!Cargo.API.Config.first_load_finished && !collection_loaded && (project_or_route || start_and_no_project) );
if(!_final_new) {
if(!start_and_no_project && !this.IsAdminEdit() && from_router && !collection_loaded) {
_final = false;
}
}
return _final;
},
/**
* If we are on a phone
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isPhone();
*/
isPhone : function() {
var md = new MobileDetect(window.navigator.userAgent);
return (typeof md.phone() == "string");
},
IsCurrentProject : function(purl) {
return (Cargo.Model.Project.GetProjectUrl() && purl && Cargo.Model.Project.GetProjectUrl().toLowerCase() == purl.toLowerCase());
},
IsCurrentProjectId : function(id) {
return (Cargo.Model.Project.GetId() && id && Cargo.Model.Project.GetProjectUrl() == id);
},
IsCurrentRoute : function(route) {
return (this.GetRouteName() && route && this.GetRouteName().toLowerCase() == route.toLowerCase());
},
/**
* A convenience method for determining if this is an HTML 5 browser
* Note: the latest version of jQuery does not support browser.version
* soooo, we need to figure out something else here
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isRecentBrowser();
*/
isRecentBrowser : function() {
// If Firefox, and version 3.6 or less
if( $.browser.mozilla && $.browser.version.slice(0,3) >= 1.9 ) {
return true;
// Check webkit, if version 3 or less
} else if ( $.browser.webkit && $.browser.version.substr(0,1) >= 4 ) {
return true;
} else {
return false;
}
},
/**
* If we are on the search route
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsSearch();
*/
IsSearch : function() {
return (this.GetRouteName().toLowerCase() == "search");
},
/**
* If the incoming string is a set
*
* @memberof Cargo.o.Helpers
* @param {string} [set] The name of a set
* @return {boolean}
* @example Cargo.Helper.IsSet(set);
*/
IsSet : function(set_name) {
return (Cargo.API.Config.set && Cargo.API.Config.set.toLowerCase() == set_name.toLowerCase());
},
/**
* If we are on a solo link
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.IsSololink();
*/
IsSololink : function() {
return Cargo.API.Config.is_solo;
},
/**
* If we are on a tablet
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.isTablet();
*/
isTablet : function() {
var md = new MobileDetect(window.navigator.userAgent);
return (typeof md.tablet() == "string");
},
/**
* If the open project is not in the active collection, put it there
* This is used primarilly for the next/previous project
*
* @memberof Cargo.o.Helpers
* @param {string} [url] URL
* @return {Backbone.Collection} A collection of projects
* @example Cargo.Helper.MakeCurrentProjectCollectionActive(url);
*/
MakeCurrentProjectCollectionActive : function( url ) {
var project_url = (url) ? url : Cargo.Helper.GetCurrentProjectUrl();
var collection_reset = false;
// If we don't find this project in the collection
if( Cargo.Helper.GetPidFromPurl( Cargo.Helper.GetCurrentProjectUrl() ) == 0) {
var found_collection = this.FindCollectionByProjectUrl( project_url );
if( found_collection ) {
Cargo.Collection.Projects.reset( found_collection );
collection_reset = true;
}
}
// Let the updater know if this was reset
return collection_reset;
},
/**
* Makes a direct link to a project from a project URL
*
* @memberof Cargo.o.Helpers
* @param {string} [purl] Project URL
* @return {string} The direct link to the project
* @example Cargo.Helper.MakeDirectLinkFromPurl(purl);
*/
MakeDirectLinkFromPurl : function( url ) {
var base = Cargo.Helper.GetBaseUrl(true, true);
return (base == '/') ? base + url : base + '/' + url;
},
/**
* Checks to see if getting a next project is possible on this page
* Will return true / false
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.NextProjectNeedsToPaginate();
*/
NextProjectNeedsToPaginate : function() {
var model = this.GetCurrentModelFromProjects();
var index = this.GetIndexFromModel( model );
if( (index+1) == Cargo.Collection.Projects.length && this.GetTotalPages() > 1 ) {
return true;
} else {
return false;
}
},
/**
* In order for the router to work with both hash and slash URLs
* It needs to have the same links always. This means that we need
* to normalize the link by removing the site URL before routing
*
* @memberof Cargo.o.Helpers
* @param {string} [url] URL
* @return {string} URL
* @example Cargo.Helper.NormalizeRouteLink(url);
*/
NormalizeRouteLink : function( url ) {
if(!url) {
return url;
}
// Sanitize the url
url = url.replace(Cargo.Helper.GetBaseDomain(), "").replace(window.location.protocol + "//","");
if(url.charAt(0) == "/") {
url = url.replace("/", "");
}
/*
* We should be left with only the route
* now see if we need to remove the Cargo url
*/
if(url.search(this.GetHomeUrl(true)) == 0) {
url = url.replace(this.GetHomeUrl(true)+"/", "");
}
return url;
},
/**
* Checks to see if getting a prev project is possible on this page
*
* @memberof Cargo.o.Helpers
* @return {boolean}
* @example Cargo.Helper.PrevProjectNeedsToPaginate();
*/
PrevProjectNeedsToPaginate : function() {
var model = this.GetCurrentModelFromProjects();
var index = this.GetIndexFromModel( model );
if( index <= 0 && this.GetTotalPages() > 1 ) {
return true;
} else {
return false;
}
},
/**
* Scroll to the top of the page
* Use a timeout because everything happens too fast without it
*
* @memberof Cargo.o.Helpers
* @example Cargo.Helper.ScrollToTop();
*/
ScrollToTop : function() {
setTimeout(function() {
// If we are further then 50 from the top, jump to 50
if($(window).scrollTop() > 50) {
window.scrollTo(0, 50);
}
// Smooth scroll the rest of the way
doscroll(0,$(window).scrollTop(),0);
}, 50);
},
/**
* Scroll to the left of the page (used for horizontal scroll designs)
* Use a timeout because everything happens too fast without it
*
* @memberof Cargo.o.Helpers
* @example Cargo.Helper.ScrollToLeft();
*/
ScrollToLeft : function(scroll_obj) {
setTimeout(function() {
if(typeof scroll_obj == "object") {
if(scroll_obj instanceof jQuery) {
scroll_obj = scroll_obj[0];
}
if($(scroll_obj).scrollLeft() > 100) {
scroll_obj.scrollLeft =100;
}
} else {
if($(window).scrollLeft() > 100) {
window.scrollTo(100, 0);
scroll_obj = window;
}
}
// Smooth scroll the rest of the way
doscroll_left(0, $(scroll_obj).scrollLeft(),0, scroll_obj);
}, 50);
},
/**
* Return the model from the collection based on project id
*
* @memberof Cargo.o.Helpers
* @param {number} [id] ID of the Project
* @return {Backbone.model} Project model
* @example Cargo.Helper.SetActiveProjectFromId(id);
*/
SetActiveProjectFromId : function( id ) {
// remove any appended increments
var id = id.split('-')[0];
// Set the new model
var model = Cargo.Collection.Projects.where( { id : parseInt(id) } );
// Set the model in the global scope
Cargo.Model.Project = model[0].toJSON();
return Cargo.Model.Project;
},
/**
* Return the model from the collection based on purl
*
* @memberof Cargo.o.Helpers
* @param {string} [purl] URL to the project
* @return {Backbone.model} Project model
* @example Cargo.Helper.SetActiveProjectFromPurl(purl);
*/
SetActiveProjectFromPurl : function( project_url ) {
// Set the new model
var model = Cargo.Collection.Projects.where( { project_url : project_url } );
// Set the model in the global scope
Cargo.Model.Project = model[0].toJSON();
return Cargo.Model.Project;
},
/**
* Shows the loading animation
* Fires an event
* Usage:
*
* Or:
*
*
* @memberof Cargo.o.Helpers
* @param {number} [pid] Project ID
* @param {string} [url] URL to the project
* @example Cargo.Helper.ShowLoadingAnimation(pid, url);
*/
ShowLoadingAnimation : function( pid, url ) {
this.Data.is_loading = true;
if( pid ) {
_.delay(function() {
Cargo.Helper.ShowLoadingAnimationById(pid);
}, Cargo.Helper.Data.loading_timout);
} else if(url) {
_.delay(function() {
Cargo.Helper.ShowLoadingAnimationById('page');
}, Cargo.Helper.Data.loading_timout);
}
$("*[data-loading=global], *[data-loading=global] .retinaSpinner").show();
},
/**
* Shows a specific loading animation based on project ID
*
* @memberof Cargo.o.Helpers
* @param {number} [id] ID of the project
* @example Cargo.Helper.ShowLoadingAnimationById(id);
*/
ShowLoadingAnimationById : function(id) {
if(this.Data.is_loading) {
$("*[data-loading="+id+"], *[data-loading="+id+"] .retinaSpinner").show();
}
},
/**
* For timeing how long things take internally
* Start and stop is the same call Cargo.Helper.Stopwatch()
*
* @memberof Cargo.o.Helpers
* @example Cargo.Helper.Stopwatch();
* @private
*/
Stopwatch : function() {
if( !this.startTime ) {
this.startTime = new Date().getMilliseconds();
} else if( !this.endTime ) {
this.endTime = new Date().getMilliseconds();
var total = this.endTime - this.startTime;
Cargo.Core.log(total+"ms");
this.startTime = false;
this.endTime = false;
}
},
/**
* We can't have wrong case in the URL because all routing is based
* on the correct case. If there is a wrong care
*/
TestUrlCaseAndRedirect: function() {
if( !Cargo.API.Config.is_domain ) {
// Test if the URL is the same case as what we have in the db
var path_url = document.location.pathname.split('/')[1],
url = Cargo.API.Config.cargo_url;
// If there are caps in the url, just keep using what the browser says
if(path_url != url && path_url.toUpperCase() == url.toUpperCase()) {
history.replaceState({}, Cargo.Model.Site.GetWebsiteTitle(), document.location.pathname.replace(path_url, url));
}
}
}
});
/***************************************************************************
*
* Router
*
**************************************************************************/
Cargo.o.router = Backbone.Router.extend({
// ==========
// = Routes =
// ==========
routes: {
"" : "Home",
"adminedit" : "Home",
"admin" : "Admin",
"admin/:section" : "Admin",
"preview/:which" : "Home",
"filter/:filter" : "FilterHome",
"filter/:filter/:purl" : "FilterProjectDetail",
":set/filter/:filter" : "SetFilterHome",
":set/filter/:filter/:purl" : "SetFilterProjectDetail",
":purl" : "FirstSlashProxy",
":purl/solo" : "SoloLink",
":purl/adminedit" : "AdminEdit",
":set/:purl" : "SetProjectDetail",
"*actions" : "defaultAction"
},
// =====================
// = Handler Functions =
// =====================
/*
* Catch all for an unhandled event
*/
defaultAction: function(actions) {
// if( this.default != actions ) {
// Cargo.Core.log("Default action: "+actions);
this.route(actions);
// }
},
/*
* This acts as a router for anything past the first slash
* Make sure it's not the URL, needs to be case insensitive
* It could be a custom route, or a set, but most likely
* it is a project
* :purl
*/
FirstSlashProxy : function( url ) {
if( this.RouteIsHome(url) ) {
this.Home();
} else if( Cargo.Helper.IsCustomRoute() ) {
this.CustomRoute( url );
} else if( Cargo.Helper.IsSet(url) ) {
this.Set( url );
} else {
this.ProjectDetail( url );
}
},
/*
* Matches the homepage link
*/
Home : function() {
/* Check for a start project
* Just tell the detail to open */
if( Cargo.API.Config.start_project && Cargo.API.Config.start_project != 0 ) {
/* Cargo.View.ProjectDetail.$el.show(); */
this.ProjectDetail( Cargo.API.Config.start_project );
if(Cargo.View.Main) {
Cargo.View.Main.SetStartProjectClass();
}
} else if(Cargo.API.Config.offline) {
/* Offline page, render load complete */
Cargo.Event.trigger("project_load_complete");
} else {
/*
* By setting the id = 0, the project model is changed
* which fires the ProjectDetail render function
* If the id=0, then the render will close instead of open
*
* Note: this was changed to "clear" and I am not sure
* what implications it has 6/28/13
*/
// Cargo.Model.Project.set( { id : 0 } );
Cargo.Model.Project.clear();
Cargo.Event.trigger("homepage_loaded");
}
},
/*
* Helper for filter homepage
* filter/:filter
*/
FilterHome : function( filter ) {
// Cargo.Core.log("Filter: "+filter);
Cargo.API.Config.filter = filter;
return this.Home( );
},
Admin : function(section) {
if($("#content_frame").length == 0 && typeof require == "function") {
Cargo.Core.loadEditor();
}
},
/*
* Helper for filter detail link
* filter/:filter/:purl
*/
FilterProjectDetail : function( filter, purl ) {
// Cargo.Core.log("Filter: "+filter);
Cargo.API.Config.filter = filter;
return this.ProjectDetail( purl );
},
/*
* Helper for set filter homepage
* :set/filter/:filter
*/
SetFilterHome : function( set, filter ) {
// Cargo.Core.log("Set: "+set+" Filter: "+filter);
Cargo.API.Config.filter = filter;
return this.Home( );
},
/*
* Helper for set filter detail link
* :set/filter/:filter/:purl
*/
SetFilterProjectDetail : function( set, filter, purl ) {
// Cargo.Core.log("Set: "+set+" Filter: "+filter);
Cargo.API.Config.filter = filter;
return this.ProjectDetail( purl );
},
/*
* Helper for set detail link
* :set/:purl
*/
SetProjectDetail : function( set, purl ) {
// Cargo.Core.log("Set: "+set+" Project: "+purl);
// This may trigger when the case is not correct on the set, in that case, go home
return ( Cargo.Helper.IsSet(set) || set.toUpperCase() == Cargo.Helper.GetHomeUrl(true).toUpperCase()) ? this.ProjectDetail( purl ) : this.Home();
},
/*
* Project detail
* :purl
*/
ProjectDetail : function( purl ) {
// Make sure this is a string
purl += "";
/* Strip any slashes from the purl */
purl = purl.replace(/\//g, "");
// Cargo.Core.log( "Router: ProjectDetail: /"+purl );
var from_router = true;
var is_perma = Cargo.Helper.IsPermalink(purl, from_router);
if( is_perma ) {
/*
* Do the permalink here
*/
if( Cargo.View.ProjectDetail ) {
Cargo.View.ProjectDetail.Permalink(purl);
}
} else if(purl && purl !== false) {
/*
* If there is no project detail element on screen
* don't ajax load, direct load by document location
*/
if(!Cargo.View.ProjectDetail && !Cargo.API.Config.offline) {
Cargo.Helper.GoToUrl( purl );
/*
* Get and set the new single project
* This will trigger an event that will automatically
* update the view
*/
} else {
Cargo.API.GetSingleProject( purl );
}
}
},
/*
* Custom route
* :route
*/
CustomRoute : function( url ) {
// Cargo.Core.log("Custom route: "+url);
Cargo.Event.trigger("custom_route_loaded", url);
if( Cargo.Helper.IsSet(url) ) {
// Cargo.Core.log("Set on custom route: "+url);
Cargo.Event.trigger("set_loaded", url);
}
},
/*
* Set
* :set
*/
Set : function( url ) {
// Cargo.Core.log("Set: "+url);
Cargo.Event.trigger("set_loaded", url);
},
/*
* Solo link is a helper for ProjectDetail
* :purl/solo
*/
SoloLink : function( purl ) {
Cargo.API.Config.is_solo = true;
Cargo.Event.trigger("solo_link_loaded", location.pathname);
return this.ProjectDetail( purl );
},
/*
* Admin edit is a helper for ProjectDetail
* :purl/adminedit
*/
AdminEdit : function( purl ) {
Cargo.API.Config.admin_edit_project = true;
return this.ProjectDetail( purl );
},
/*
* Rewrite the route Regex to allow for case insensitivity and trailing slash support
* Note: This was copied directly from backbone and added the "i" param
* as well as \/? conditional with the second replace(regex)
*/
_routeToRegExp: function (route) {
route = route.replace(/[-{}[\]+?.,\\^$|#\s]/g, '\\$&')
.replace(/\((.*?)\)/g, '(?:$1)?')
.replace(/:\w+/g, '([^\/]+\/?)')
.replace(/\*\w+/g, '(.*?)');
return new RegExp('^' + route + '$', 'i');
},
/*
* Make a shorthand reference for adding a route with Backbone
* Also update this to include all variants possible
* This includes trailing slash and query strings
*/
addroute : function( route, name, callback ) {
var variants = [
'', // normal route
'/', // trailing slash
'?*querystring', // querystrings
'/?*querystring' // trailing slash + querystrings
];
// Bind a route for each of the variants
for (var i=0; i < variants.length; i++) {
var variant = variants[i];
// Backbone.Router.prototype.route.call(this, route+variant, name, callback);
this.route( route+variant, name, callback );
}
},
RouteIsHome : function(url) {
var is_home = false;
// If the incoming url matches the normalized Cargo url
if( !Cargo.API.Config.is_domain && url.toLowerCase() == Cargo.Helper.GetDomainOrUrl().toLowerCase() ) {
// Make sure this is not a project called the same as the URL
if(document.location.pathname.replace("/").split("/").length <= 1) {
is_home = true;
}
}
return is_home;
}
});
/***************************************************************************
*
* Templates
* This is the template manager function file
* It loads and caches tempaltes
* Uses require.js to async load in templates
*
**************************************************************************/
Cargo.o.templates = Backbone.View.extend({
/* Data store for templates */
Data : { },
/**
* Gets a template based on a name
* If one is not available in memory, async load it
*/
Get : function( which, file_path ) {
which = Cargo.Helper.GetBackboneCaseInsensitive(this.Data, which);
if( this.Data[which] && this.Data[which].template ) {
return this.Data[which].template;
} else {
this.Load( which, file_path );
}
},
/**
* Gets a template element based on a name
* If one is not available in memory, async load it
*/
GetEl : function( which ) {
which = Cargo.Helper.GetBackboneCaseInsensitive(this.Data, which);
if( this.Data[which] ) {
return this.Data[which].element;
} else {
this.Load( which );
}
},
/**
* Add a template to the list
* Note: This does not load the template view
*/
Add : function( template, element, dataset, setname ) {
Cargo.Template.Data[template] = {
dataset : dataset,
setname : setname,
element : element
}
},
/**
* Loops through the dom to find view stubs
* Seeks out the "data-view" attribute, which can be associated with any
* html element
*/
FindAndAddViewStubs : function( ) {
var self = this;
$("[data-view]").each(function() {
var template = $(this).data("view");
var setname = $(this).data("set");
var el = ( $(this).attr("id") ) ? "#" + $(this).attr("id") : "." + $(this).attr("class");
/*
* For the dataset, find if it is collection or model
* If it does not exist, then use Default Collection
*/
// var dataset = $(this).data("set");
var dataset = Cargo.Collection.Default;
if(setname) {
var requested_collection = Cargo.Helper.GetBackboneCaseInsensitive(Cargo.Collection, setname);
var requested_model = Cargo.Helper.GetBackboneCaseInsensitive(Cargo.Model, setname);
if( requested_collection ) {
dataset = Cargo.Collection[requested_collection];
} else if( requested_model ) {
dataset = Cargo.Model[requested_model];
}
}
/* Add the template to the stack */
Cargo.Template.Add( template, el, dataset, setname );
});
},
/**
* Loads a single template into memory
*
* Note: For api routes that are not on this domain (ie: api.cargo)
* then we must load the design like a variable with the "true" flag
* Otherwise, load the template like normal.
*/
Load : function( which, file_path ) {
if(!file_path) {
var file_name = which + ".handlebars";
// file_path = Cargo.API.GetDesignAndFile(file_name, true);
file_path = Cargo.API.GetDesignAndFile(file_name, false);
}
if( !Cargo.Template.Data[which] || !Cargo.Template.Data[which].loading ) {
if( !Cargo.Template.Data[which] ) {
Cargo.Template.Data[which] = { };
}
Cargo.Template.Data[which].loading = true;
$.loadFiles( file_path ).done( function( template ) {
/*
* If no value for template was passed, require loaded it like a script
*/
if( template ) {
/*
* Evaluate the response, it may come as a string
*/
try {
var template = eval(template);
} catch(err) {
// nothing
}
Cargo.Template.Data[which].template = template;
} else {
/*
* The name of the output variable is = to the file name, without / & .
*/
var template_var = "templatesdesign" + file_name.replace(/(\/|\.)/g, "");
Cargo.Template.Data[which].template = window[template_var];
}
/* Fire an event notifying of the newly loaded template */
Cargo.Event.trigger("template_loaded", which );
return Cargo.Template.Data[which].template;
});
}
},
/**
* Load all non-loaded template into memory async
* Loops through the template list and loads any template
* that has yet to be loaded (this is determined if the "template" var is blank)
*/
LoadAll : function( ) {
for(key in this.Data) {
if( typeof(this.Data[key].template) == "undefined" ) {
this.Load( key );
}
}
},
/**
* Loops through the templates and checks if they have
* A view already loaded for them
* If not, it will load a view
* @note: this is not really ideal like this
* @note: perhaps have a view controller
*/
LoadFoundViews : function() {
/*
* Loop through the templates and check to see if a view
* has been init yet. If not, do it
*/
for(key in this.Data) {
var requested_view = Cargo.Helper.GetBackboneCaseInsensitive(Cargo.o.view, key);
if(
typeof(Cargo.o.view[requested_view]) == "function" &&
typeof(Cargo.View[requested_view]) == "undefined"
) {
var self = this;
/* Handle the case for multiple of the same view on the page */
$("[data-view='"+key+"']").each(function(i) {
var el = ( $(this).attr("id") ) ? "#" + $(this).attr("id") : "." + $(this).attr("class");
var final_view = (i>0) ? requested_view+"_"+i: requested_view;
Cargo.View[final_view] = new Cargo.o.view[requested_view]({
el : el,
collection : self.Data[key].dataset,
template : self.Data[key].template,
className : final_view
});
});
} else {
if( typeof(Cargo.View[requested_view]) == "function" ) {
Cargo.Core.log("A view for "+requested_view+" already loaded");
} else if(typeof(Cargo.o.view[requested_view]) == "undefined") {
/* If there is no view, then the user likely
* just added data-view="something"
* In this case, make a view based on our default */
Cargo.View[key] = new Cargo.o.view.Default({
el : this.Data[key].element,
collection : this.Data[key].dataset,
template : key,
datasetname : this.Data[key].setname,
className : key
});
}
}
}
}
});
/***************************************************************************
*
* Addition to Cargo core functionality
*
* The slideshow class
* Cargo.Core.Slideshow.InitSlideshow();
*
* Created on 6/26/13 for 2.0
*
**************************************************************************/
Cargo.Core.Slideshow = {
uid: 0,
InitSlideshow : function() {
var self = this;
$(".slideshow").not('[data-slideshow-initialized]').each(function() {
// Shorthand for display options
var dop = Cargo.Model.DisplayOptions;
var opts = {
// Transitions
"transition" : dop.GetSlideTransition(),
"transition_duration" : dop.GetSlideTransitionDuration(),
// Autoplay
"autoplay" : dop.GetSlideAutoPlay().enabled,
"autoplay_duration" : dop.GetSlideAutoPlay().delay,
// Display
"navigation" : dop.GetSlideTextNav().enabled,
"thumbnails" : dop.GetSlideThumbnails().enabled,
"toggle_thumbnails" : dop.GetSlideToggleThumbLink().enabled,
"default_thumbnails" : dop.GetSlideDefaultThumbs(),
"square_thumbnails" : false
};
$(this).attr('data-id', $(this).attr('data-id') + '-' + (self.uid++));
$(this).cargoSlideshow(opts);
});
},
ShowCaption : function() {
},
// this is where slideshows register theirselves
SlideshowObjects : {
}
}
/**************************************************************************
*
* Addition to Cargo core functionality
*
* The handlebars rendering class
*
* Usage:
* Cargo.Core.Handlebars.Render();
*
**************************************************************************/
Cargo.Core.Handlebars = {
/**
* Uses handlebars to render a template and data model
* registers any helpers that need to go with the render
* used by all views that render data
* returns the compiled markup
*/
Render : function(template, data_model) {
// Get the compiled template
var compiled = Handlebars.compile( template );
/*
* Register partials
*/
Handlebars.registerPartial("loading_animation", $("#loading_animation").html());
/*
* Register all helpers
*/
this.RegisterHelper_Asset();
this.RegisterHelper_AssetContents();
this.RegisterHelper_Print();
this.RegisterHelper_IfAny();
this.RegisterHelper_IfAll();
this.RegisterHelper_IfEqual();
this.RegisterHelper_UnlessAny();
this.RegisterHelper_UnlessAll();
this.RegisterHelper_IfOption();
this.RegisterHelper_UnlessOption();
this.RegisterHelper_DisplayOptions();
this.RegisterHelper_Truncate();
/*
* Finalize with the model
*/
var markup = compiled( data_model );
return markup;
},
/**
* This method is just the same as above
* However, this render only uses the assets helper and
* nothing else. It is used for rendering the CSS content
* from the preview panel
*/
RenderOnlyAssets : function(template) {
var compiled = Handlebars.compile( template );
this.RegisterHelper_Asset();
var markup = compiled();
return markup;
},
/*
* Register a helper for assets
*/
RegisterHelper_Asset : function() {
Handlebars.registerHelper('asset', function(options) {
var asset = options.fn(this);
var model = Cargo.Collection.Assets.where( { filename : asset } )[0];
return (model) ? Cargo.Model.Site.GetAssetPath(model.get('filename'), model.get('id')) : "";
});
},
/*
* Register a helder for assets
*/
RegisterHelper_AssetContents : function() {
Handlebars.registerHelper('asset_contents', function(options) {
var asset = options.fn(this);
var model = Cargo.Collection.Assets.where( { filename : asset } )[0];
var file = (model) ? Cargo.Model.Site.GetAssetPath(model.get('filename'), model.get('id')) : "";
$.get(file, function(data) {
// Try to replace immediately
$("file[data-url='"+file+"']").after(data).remove();
// Also try a little later, in case the DOM has not been updated
setTimeout(function() {
$("file[data-url='"+file+"']").after(data).remove();
}, 500);
}, 'text');
return '';
});
},
/*
* Register a helper for print
*/
RegisterHelper_Print : function() {
Handlebars.registerHelper('print', function(context, options) {
var wrapper_head = wrapper_tail = "";
if(context == "project.content" || context == "content") {
wrapper_head = "";
wrapper_tail = "";
}
context = context.replace("project.","");
var model = (typeof this.project == "object") ? this.project : this;
if(Cargo.Model.Site.GetUseHiRes()) {
if(model[context + '_2x'] != null){
context += "_2x";
}
}
return new Handlebars.SafeString(wrapper_head + model[context] + wrapper_tail);
});
},
/*
* Register a helper for if_any
*/
RegisterHelper_IfAny : function() {
Handlebars.registerHelper('if_any', function() {
var any = false;
var options = arguments[arguments.length-1];
for (var i = arguments.length - 2; i >= 0; i--) {
if( arguments[i] ) {
any = true;
break;
}
}
return (any) ? options.fn(this) : options.inverse(this);
});
},
/*
* Register a helper for if_all
*/
RegisterHelper_IfAll : function() {
Handlebars.registerHelper('if_all', function() {
var all = true;
var options = arguments[arguments.length-1];
for (var i = arguments.length - 2; i >= 0; i--) {
if( !arguments[i] ) {
all = false;
break;
}
}
return (all) ? options.fn(this) : options.inverse(this);
});
},
/*
* Register a helper for if_equal
*/
RegisterHelper_IfEqual : function() {
Handlebars.registerHelper('if_equal', function(value_one, value_two, options) {
if (arguments.length != 3) {
return '';
}
return (value_one == value_two) ? options.fn(this) : options.inverse(this);
});
},
/*
* Register a helper for unless_any
*/
RegisterHelper_UnlessAny : function() {
Handlebars.registerHelper('unless_any', function() {
var any = false;
var options = arguments[arguments.length-1];
for (var i = arguments.length - 2; i >= 0; i--) {
if( !arguments[i] ) {
any = true;
break;
}
}
return (any) ? options.fn(this) : options.inverse(this);
});
},
/*
* Register a helper for unless_all
*/
RegisterHelper_UnlessAll : function() {
Handlebars.registerHelper('unless_all', function() {
var all = true;
var options = arguments[arguments.length-1];
for (var i = arguments.length - 2; i >= 0; i--) {
if( arguments[i] ) {
all = false;
break;
}
}
return (all) ? options.fn(this) : options.inverse(this);
});
},
/*
* Register a helper for display options
*/
RegisterHelper_DisplayOptions : function() {
Handlebars.registerHelper('displayoptions', function(context, options) {
// Split the context into args
var args = context.replace('display_options.','').split(".");
// Find out how many options
var count = args.length;
// Assume we are not passing this condition
var condition = false;
if(count == 1) {
condition = Cargo.Model.DisplayOptions.get(args[0]);
} else if(count == 2) {
condition = Cargo.Model.DisplayOptions.get(args[0])[args[1]];
} else if(count == 3) {
condition = Cargo.Model.DisplayOptions.get(args[0])[args[1]][args[2]];
} else {
condition = Cargo.Model.DisplayOptions.get(args[0]);
}
return (condition) ? options.fn(this) : options.inverse(this);
});
},
/*
* Register a helper for display options
*/
RegisterHelper_IfOption : function() {
Handlebars.registerHelper('if_option', function(context, options) {
// Split the context into args
var args = context.replace('display_options.','').split(".");
// Find out how many options
var count = args.length;
// Assume we are not passing this condition
var condition = false;
if(count == 1) {
condition = Cargo.Model.DisplayOptions.get(args[0]);
} else if(count == 2) {
condition = Cargo.Model.DisplayOptions.get(args[0])[args[1]];
} else if(count == 3) {
condition = Cargo.Model.DisplayOptions.get(args[0])[args[1]][args[2]];
} else {
condition = Cargo.Model.DisplayOptions.get(args[0]);
}
return (condition) ? options.fn(this) : options.inverse(this);
});
},
/*
* Register a helper for display options
*/
RegisterHelper_UnlessOption : function() {
Handlebars.registerHelper('unless_option', function(context, options) {
// Split the context into args
var args = context.replace('display_options.','').split(".");
// Find out how many options
var count = args.length;
// Assume we are not passing this condition
var condition = false;
if(count == 1) {
condition = Cargo.Model.DisplayOptions.get(args[0]);
} else if(count == 2) {
condition = Cargo.Model.DisplayOptions.get(args[0])[args[1]];
} else if(count == 3) {
condition = Cargo.Model.DisplayOptions.get(args[0])[args[1]][args[2]];
} else {
condition = Cargo.Model.DisplayOptions.get(args[0]);
}
return (!condition) ? options.fn(this) : options.inverse(this);
});
},
RegisterHelper_Truncate : function() {
Handlebars.registerHelper ('truncate', function (str, len) {
if (str.length > len && str.length > 0) {
var new_str = str + " ";
new_str = str.substr (0, len);
new_str = str.substr (0, new_str.lastIndexOf(" "));
new_str = (new_str.length > 0) ? new_str : str.substr (0, len);
return new Handlebars.SafeString ( new_str +'...' );
}
return str;
});
}
}
/**************************************************************************
*
* Addition to Cargo core functionality
*
* The video class
* This method is a replica of the one found in site.package
* The "reverse fallback" -- Flash object and HTML5 video tags are both housed
* within a div.video_component. The CheckForVideo() method determines who gets
* to stay, in essence, and removes the unused tags.
*
* Usage:
* Cargo.Core.Video.CheckForVideo();
*
**************************************************************************/
Cargo.Core.Video = {
Config: {
DEBUG: false,
dependencies: [
'/_css/mediaplayer.css',
'/_jsapps/_libs/jquery-ui-1.10.3.custom.min.js',
'/_js/cargo.video.package.js'
],
volume_default: 0.75,
volume: 1,
muted: false
},
/**
* DEBUG
*
* Controlled by Config.DEBUG, MightForceHTML5() and IsForcingHTML5() modify,
* dependent upon the presence of the cargo.video.forcedHTML5 cookie, the
* behavior of DetectPlugin() and DestroyFallbackTags() - always displaying
* the video elements.
*
* ForceHTML5() controls the cargo.video.forcedHTML5 cookie and enables video
* elements accordingly.
*/
MightForceHTML5: function() {
return this.Config.DEBUG;
},
IsForcingHTML5: function() {
if (this.Config.is_forcing_HTML5 !== undefined)
return this.Config.is_forcing_HTML5;
var forcing_HTML5 = $.cookie('cargo.video.forcedHTML5') || false;
if (forcing_HTML5)
this.Config.has_flash_plugin = false;
this.Config.is_forcing_HTML5 = forcing_HTML5;
return forcing_HTML5;
},
ForceHTML5: function() {
var should_force_HTML5 = $.cookie('cargo.video.forcedHTML5') || false;
this.Config.force_HTML5 = ! should_force_HTML5;
if (this.Config.force_HTML5) {
$.cookie('cargo.video.forcedHTML5', true, {expires: 30, path: '/'});
this.Config.has_flash_plugin = false;
this.CheckForVideo();
} else {
$.cookie('cargo.video.forcedHTML5', null, {path: '/'});
window.location.reload();
}
},
/**
* Primary method, determines if there are videos present and, if so, if there
* is a need to "reverse fallback" to an HTML5 player. Upon fallback, loads the
* related CSS and javascript should they not already exist, calling back to
* itself recursively, rearranging and removing Flash and HTML5 elements, and
* finally applying the HTML5 player controls.
*
* @param video_js_has_loaded Boolean, true on recursive call after load of external CSS and javascript files
*/
CheckForVideo: function(video_js_has_loaded) {
if (!this.DetectVideos())
return;
if (this.DetectPlugin()) {
this.DestroyFallbackTags();
return;
}
// Load video-related javascript here, but only once
if (this.Config.has_video_js === undefined) {
if (video_js_has_loaded) {
this.Config.has_video_js = true;
} else {
if (this.Config.is_loading_video_js !== undefined)
return;
this.Config.is_loading_video_js = true;
// Actual loading of external dependencies
$.loadFiles(this.Config.dependencies).done(function() {
Cargo.Core.Video.CheckForVideo(true);
});
return;
}
}
// Culling of the object tags, displaying of the video tags
$('.video_component').each(function() {
$(this).children('object').remove();
var video_tag = $(this).children('.video_tag');
var player = video_tag.children();
video_tag.css({
display: 'inline-block',
width: player.attr('data-video-width'),
height: player.attr('data-video-height')
});
// Apply jMediaelement controls after javascript has loaded
if (Cargo.Core.Video.Config.has_video_js)
Cargo.Core.Video.ConfigureMediaPlayer(player);
});
},
/**
* Application of jMediaelement controls to video tags
*/
ConfigureMediaPlayer: function(player) {
// Don't call video player methods more than once
if (player.attr('data-video-configured') !== undefined)
return;
player.attr('data-video-configured', 'true');
// Grab volume settings from cookies or defaults
this.Config.volume = $.cookie('cargo.video.volume') || this.Config.volume_default;
this.Config.muted = ($.cookie('cargo.video.muted')) ? true : false;
// Apply jMediaelement controls, custom volume logic
player.jmeInit().jmeProp('controlbar', true);
player.children('video').each(function(index, video) {
$(video).bind('volumechange', function() {
var control = $('.mute-unmute');
var volume = Number($(this).jmeValue('volume'));
var muted = $(this).jmeValue('muted');
if (volume > 0.66) {
control.removeClass('volume-medium volume-low').addClass('volume-high');
} else if (volume <= 0.66 && volume > 0.33) {
control.removeClass('volume-high volume-low state-mute state-unmute').addClass('volume-medium');
} else if (volume <= 0.33 && volume > 0.01) {
control.removeClass('volume-high volume-medium state-mute state-unmute').addClass('volume-low');
} else {
control.removeClass('volume-high volume-medium volume-low').addClass('state-unmute');
}
if (muted) {
control.addClass('state-unmute');
$.cookie('cargo.video.muted', true, {expires: 30, path: '/'});
} else {
$.cookie('cargo.video.muted', null, {path: '/'});
}
$.cookie('cargo.video.volume', volume, {expires: 30, path: '/'});
});
video.volume = Cargo.Core.Video.Config.volume;
video.muted = Cargo.Core.Video.Config.muted;
});
},
/**
* Determine if the browser supports and has the Flash plugin installed
*
* @return Boolean, whether detected
*/
DetectPlugin: function() {
// Only check for Flash once
if (this.Config.has_flash_plugin !== undefined)
return this.Config.has_flash_plugin;
// During debug, always report a lack of Flash
if (this.MightForceHTML5()) {
if (this.IsForcingHTML5())
return false;
}
var flash_was_detected = false;
if (typeof navigator.plugins != 'undefined' && typeof navigator.plugins['Shockwave Flash'] == 'object') {
var d = navigator.plugins['Shockwave Flash'].description;
if (d && !(typeof navigator.mimeTypes != 'undefined' && navigator.mimeTypes['application/x-shockwave-flash'] && !navigator.mimeTypes['application/x-shockwave-flash'].enabledPlugin))
flash_was_detected = true;
} else if (typeof window.ActiveXObject != 'undefined') {
try {
if ((new ActiveXObject('ShockwaveFlash.ShockwaveFlash')))
flash_was_detected = true;
} catch(e) {}
}
this.Config.has_flash_plugin = flash_was_detected;
return flash_was_detected;
},
/**
* Get a count of the div.video_component elements, confirm if there is more
* than one present
*
* @return Boolean, true if one or more
*/
DetectVideos: function() {
return ($('.video_component').length > 0);
},
/**
* Remove the video tag parent div, even though it is not displayed, just to be
* extra, extra safe
*/
DestroyFallbackTags: function() {
// During debug, do not remove the video tags
if (this.MightForceHTML5())
return;
if (this.Config.was_destroyed !== undefined)
return;
this.Config.was_destroyed = true;
$('.video_component .video_tag').each(function(index, value) {
$(this).remove();
});
}
}
/*
* End Cargo.Core.Video
*/
/**************************************************************************
*
* Addition to Cargo core functionality
*
* The audio class
* This method is a replica of the one found in site.package
*
* Usage:
* Cargo.Core.Audio.CheckForAudio();
*
**************************************************************************/
// This value is needed by sound manager and is global because of legacy
var start_sound =
this_play = false;
Cargo.Core.Audio = {
Config: {
has_audio_js : false,
dependencies: [
'/_jsapps/_libs/jquery-ui-1.10.3.custom.min.js',
'/_js/soundmanager/api/soundmanager2-nodebug-jsmin.js'
]
},
/**
* Primary method, determines if there are audio players present and, if so, load them
*
* @param audio_js_has_loaded Boolean, true on recursive call after load of external CSS and javascript files
*/
CheckForAudio : function() {
if (!this.DetectAudioPlayer())
return;
this.UnloadAudio();
this.InitButtons();
this.InitPlayerSize();
if(Cargo.Helper.isMobile()){
// preload audio JS because of IOS issues
// Sound play() calls are blocked by the OS unless in direct response to a user event like touch or click
// http://www.schillmania.com/projects/soundmanager2/doc/technotes/#mobile-device-limitations
Cargo.Core.Audio.LoadDependancies(null, function(){
$(window).ready(function(){
setupSoundManager();
});
});
}
},
InitButtons : function() {
$(".audio_component .play_pause").off('click').on('click', function(e) {
e.preventDefault();
var force = false;
if (/Firefox[\/\s](\d+\.\d+)/.test(navigator.userAgent)) {
var ffversion=new Number(RegExp.$1);
if(ffversion < 3.6) { force = true; }
}
var rel = $(this).attr("rel");
var which = $(this).attr("class").replace("play_pause ", "");
// Trigger the event of playing the audio
Cargo.Event.trigger("audio_play_pause", rel, which );
// Load dependancies, or toggle the sound
if( !Cargo.Core.Audio.Config.has_audio_js ) {
// console.log("load");
Cargo.Core.Audio.LoadDependancies($(this), function(){
setupSoundManager();
});
} else {
// console.log("toggle");
Cargo.Core.Audio.ToggleSound($(this));
}
});
if($("#DroidFont").length <= 0) {
// Load the external font from the google api
var droidfont=document.createElement('link');
droidfont.id='DroidFont';
droidfont.setAttribute('type','text/css');
droidfont.setAttribute('rel','stylesheet');
droidfont.setAttribute('href','https://fonts.googleapis.com/css?family=Droid+Sans+Mono');
var hd=document.getElementsByTagName('head')[0];
hd.appendChild(droidfont);
};
$(".progress").css("display","none");
},
/**
* Set the player size of the audio component
* Also set the position of each element
*/
InitPlayerSize : function() {
var total_players = $(".audio_component").length;
var zero_count = 0;
$(".audio_component").each(function(){
if($(this).width() > 0) {
// Setup playhead/progress width
//$('.Href', this).hide();
var position = $(".position", this);
var playhead = $(".playhead", this);
// This makes the player correctly sized based on the .Sound width property
var soundWidth = $(this).width();
var soundBordersWidth = $(".border", this).outerWidth() - $(".border", this).width();
var controlsWidth = $(".controls", this).width(soundWidth - soundBordersWidth).width();
var volumeWidth = $(".volume", this).width();
var playpauseWidth = $(".play_pause", this).width();
var spacerWidths = $(".vertical_border", this).width() * 2;
$(".border", this).width(soundWidth - soundBordersWidth);
$(".info", this).width(controlsWidth - volumeWidth - playpauseWidth - spacerWidths);
var refWidth = $(".info", this).width();
position.width(refWidth);
playhead
.css("width", refWidth+"px")
.css("left", 0);
var progressBordersWidth = $(".progress", this).outerWidth() - $(".progress", this).width();
$(".progress")
.css("width", (refWidth - progressBordersWidth) +"px")
.css("left", 0);
if($("#home_content").length > 0) var prog_left = "35px";
else var prog_left = "0px";
$(".progress_clip")
.css("position", "absolute")
.css("overflow", "hidden")
.css("width", refWidth+"px")
.css("left", prog_left);
$(".position")
.css("left", prog_left);
$(".playhead_container", this)
.css("position", "relative")
.css("width", (playhead.outerWidth() * 2) + "px")
.css("left", ((playhead.outerWidth() * -1)) + "px");
$(".progress_container", this)
.css("position", "absolute")
.css("z-index", "-1")
.css("width", (playhead.outerWidth() * 2) + "px")
.css("left", ((playhead.outerWidth() * -1)) + "px");
} // end width check
else {
zero_count++;
}
});
if( zero_count > 0 && zero_count == total_players) {
// This content is not yet loaded because the container is faded out
// Pause for 1 sec, then enable
setTimeout("Cargo.Core.Audio.InitPlayerSize()", 500);
}
},
/**
* Load all javascript dependancies
*/
LoadDependancies : function(el, callback) {
// Load audio-related javascript here, but only once
if (this.Config.has_audio_js === false) {
$.loadFiles(this.Config.dependencies).done(function() {
Cargo.Core.Audio.ToggleSound(el);
Cargo.Core.Audio.Config.has_audio_js = true;
if(typeof callback == "function"){
callback();
}
});
return;
}
},
/**
* When the play/pause button is pressed
*/
ToggleSound : function(el) {
start_sound = $(el).parents(".audio_component").attr("id");
this_play = $(el);
},
/**
* Get a count of the div.audio_component elements, confirm if there is more
* than one present
*
* @return Boolean, true if one or more
*/
DetectAudioPlayer: function() {
return ($('.audio_component').length > 0);
},
/**
* Removes any sound object from the page
*/
UnloadAudio : function() {
$(".audio_component").each(function() {
if(typeof soundManager == "object") {
soundManager.unload( $(this).attr("id") );
}
});
}
};
/**************************************************************************
*
* Addition to Cargo "core" functionality
*
* The social media class
* This method is a replica of the one found in site.package
*
* Usage:
* Cargo.Core.SocialMedia.Init();
*
**************************************************************************/
/**
* This is the main social media app
* It will contain the various services
* NOTE:
* The var "Services" sits at the bottom of this method
* this defines each socail network and their dependencies
* it must sit at the bottom, not the top
*/
Cargo.Core.SocialMedia = {
/*
* Pre-define the services and their respective scripts that need loading
*/
"Services" : {
"facebook" : {
"script" : false, // script url for inclusion at write time
"inuse" : false // if this is in use or not, always default false
},
"twitter" : {
"script" : "http://platform.twitter.com/widgets.js",
"inuse" : false
},
"pinterest" : {
"script" : false,
"inuse" : false
},
"googleplus" : {
"script" : "https://apis.google.com/js/plusone.js",
"inuse" : false
},
"stumbleupon": {
"script" : "http://platform.stumbleupon.com/1/widgets.js",
"inuse" : false
},
"reddit" : {
"script" : "http://www.reddit.com/buttonlite.js?i=5",
"inuse" : false
}
},
"Options" : {
"element" : ".project_footer", // The selector element to bind the html to
"show_count" : false, // Show the "like" count or not
"twitter_username" : false // Twitter username for @reply
},
"OutputHTML" : "", // The HTML that will be printed to the element
/*
* Set the defaults of the socail media elements
*/
SetDefaults : function( which, value ) {
if(which == "element" || which == "show_count" || which == "twitter_username") {
this.Options[which] = value;
} else {
// set the "inuse" value for the default
this.Services[which].inuse = value;
}
},
/*
* Initialize the services
*/
Init : function() {
// Set a delay to listen to the collection loaded
if(Cargo.Helper.IsFeedDesign()) {
Cargo.Event.on('project_collection_reset', function() {
Cargo.Core.SocialMedia.Start();
});
} else {
this.Start();
}
},
Start : function() {
// Reset the output values
this.OutputHTML = "";
// Create the HTML
this.CreateHTML();
// Write the HTML
this.WriteHTML();
},
/*
* Gets a project title
*/
AddHTML : function( html ) {
this.OutputHTML += html;
},
/*
* Takes the HTML that was created by the methods below
* Replaces the stubs with real content
* Stubs are for direct link / encoded direct link / title
* Input is a PID of the element we are binding
* If no PID is passed, it will default to site link / html title
*/
GetFormattedHTML : function( pid ) {
var final_output = this.OutputHTML;
var project_model = Cargo.Collection.Projects.where( { id : pid } )[0];
project_model = (typeof project_model == "undefined") ? Cargo.Model.Project : project_model;
// Direct link
final_output = final_output.replace(/CARGO_DIRECT_LINK/g, project_model.get('direct_link') );
// Encoded direct link
final_output = final_output.replace(/CARGO_ENCODED_DIRECT_LINK/g, encodeURIComponent(project_model.get('direct_link')) );
// Title
final_output = final_output.replace(/CARGO_PROJECT_TITLE/g, project_model.get('title_no_html') );
// Return the results
return final_output;
},
/*
* Write the buttons to the choosen element
*/
WriteHTML : function() {
// Attach the content to the choosen element/selector
$(this.Options.element)
.each(function() {
// Add to reclusive elements. Make them social, but skip ones that already are social.
if($(this).data("has_social") !== true) {
$(this)
.append('
');
if(Cargo.ReplaceLoadingAnims === undefined){
Cargo.Core.ReplaceLoadingAnims.init();
} else {
Cargo.ReplaceLoadingAnims();
}
// remove styleSheets
var styles = document.head.querySelectorAll('link, style');
for(var i = 0; i < styles.length; i++){
document.head.removeChild(styles[i]);
}
// add our styleSheet
var style = document.createElement('link');
style.href = self.files.styleSheet;
style.rel = 'stylesheet';
document.head.appendChild(style);
var frame = document.createElement('iframe');
frame.className = 'bodyframe';
frame.setAttribute('data-inspector', 'true');
frame.setAttribute('frameborder', '0');
document.body.appendChild(frame);
$(frame).css('opacity', 0);
// url must be different from the current one to make it work in FF.
var newSrc = window.location.href.replace(/\?inspector|\/admin\/css/gi, '');
if(newSrc.indexOf('?') === -1){
newSrc += '?inspecting';
} else {
newSrc += '&inspecting';
}
frame.src = newSrc;
// frame loaded. We can access it's DOM now.
frame.onload = function(){
injectInspectorCore(frame);
//frame.style.visibility = 'hidden';
}
}
var injectInspectorCore = function(frame){
// inject the inspector API into the frame
var script = frame.contentDocument.createElement('script');
script.src = self.files.corePackage;
frame.contentDocument.head.appendChild(script);
// once the API has loaded we can instanciate the editor.
script.onload = function(){
if(window.editor === undefined){
initializeInspector(frame);
} else {
window.editor.reloadFrameReferences();
}
}
}
var initializeInspector = function(frame){
// instanciate the editor and tell it to inspect the frame instead of the
// current document by passing the iframe object.
$("#follow_popup, .ci-loader").remove();
var options = $.extend({
iframe: frame,
styleSheetFilter: function(styleSheet){
/*if(styleSheet.ownerNode.nodeName === "STYLE"){
return false;
}
// adblock inserts style nodes with script tags in it...
if(styleSheet.ownerNode !== null){
if($(styleSheet.ownerNode).find('script').length > 0){
return false;
}
}
if(styleSheet.href !== null) {
if(styleSheet.href.indexOf('global.css') !== -1){
return false;
}
}*/
if(styleSheet.ownerNode !== null){
if(styleSheet.ownerNode.id.indexOf('member_stylesheet') !== -1 || styleSheet.ownerNode.id.indexOf('user_stylesheet') !== -1 ){
return true;
}
}
return false;
},
styleSheetSavableFilter: function(styleSheet){
if(styleSheet.ownerNode !== null){
if(styleSheet.ownerNode.id.indexOf('member_stylesheet') !== -1 || styleSheet.ownerNode.id.indexOf('user_stylesheet') !== -1 ){
return true;
}
}
return false;
},
onResize: function(){
$(window).resize();
},
onInspectorClick: function(e){
// don't preventDefault if a splash page has been clicked.
if(e.target.id !== "splash"){
e.preventDefault();
}
if( $(e.target).closest('#toolset').length > 0 ) {
return false;
}
if(e.target.nodeName === "HTML") {
e.target = document.body;
}
// return the element that is going to be inspected.
return e.target;
},
onSave: function(button, modifiedFiles){
var styleSheetPostArray = [];
var self = this;
for(var i = 0; i < modifiedFiles.length; i++){
styleSheetPostArray.push({
filename: encodeURIComponent(modifiedFiles[i].filename),
stylesheet: modifiedFiles[i].cssString,
});
}
$.ajax({
type: "POST",
url: '/dispatch/admin/saveInspectorCSS',
data: {
stylesheet: JSON.stringify( styleSheetPostArray ),
url: ( Cargo.Helper ? Cargo.Helper.GetUrl() : frame.contentWindow.Cargo.Location.GetCargoUrl() )
},
success: function(response){
if(response.error.length > 0){
button.$el.removeClass('saving');
if(response.error[0].message) {
alert(response.error[0].message);
} else {
alert('Save failed');
}
} else {
for(var i = 0; i < modifiedFiles.length; i++){
modifiedFiles[i].CSSStyleSheet.markAsSaved();
}
}
},
always: function(){
button.$el.removeClass('saving');
},
dataType: 'json'
});
}
}, customOptions);
window.editor = new CSSEditor(options);
document.body.appendChild(window.editor.getEditorElement());
window.editor.getEditorElement().style.setProperty('visibility', 'hidden', 'important');
var init = true;
$(window).resize(function(){
var editorWidth = editor.getEditorElement().offsetWidth;
windowWidth = document.documentElement.offsetWidth;
frame.style.width = (windowWidth - editorWidth) + 'px';
frame.style.left = editorWidth + 'px';
if(init){
$(frame).css('opacity', '');
window.editor.getEditorElement().style.removeProperty('visibility');
init = false;
}
});
$(window).resize();
//frame.style.visibility = '';
//
var c = window.editor.options.coreWindow.Cargo;
if(c.hasOwnProperty('Event')){
c.Event.trigger('inspector_open');
}
}
var adminURLIndex = document.location.href.indexOf('/admin/css');
if( (Cargo.Helper ? Cargo.Helper.isMobile() : Cargo.Config.isMobile()) ) {
alert('Sorry, the Inspector does not support iOS (yet).');
if(adminURLIndex !== -1){
document.location.href = document.location.href.substring(0, adminURLIndex);
}
return false;
}
if( (Cargo.Helper ? Cargo.Helper.isIE8() : Cargo.Config.isIE8()) ) {
alert('Sorry, the Inspector does not support your browser version.');
if(adminURLIndex !== -1){
document.location.href = document.location.href.substring(0, adminURLIndex);
}
return false;
}
Cargo.InspectorLoading = true;
$("#follow_popup").remove();
$.post("/dispatch/admin/authenticateInspector", {url: ( Cargo.Helper ? Cargo.Helper.GetUrl() : Cargo.Location.GetCargoUrl() ) }, function(authenticationData) {
if(authenticationData.error.length === 0) {
injectFrontendPackage();
} else if(authenticationData.error[0].message) {
alert(authenticationData.error[0].message);
} else {
alert("You must be logged in to use the Inspector.");
if(adminURLIndex !== -1){
document.location.href = document.location.href.substring(0, adminURLIndex);
}
}
}, 'json');
//injectFrontendPackage();
}
}
Cargo.utils = Cargo.utils || {};
/**
* Cargo.Core.CargoXHR wraps the native XMLHttpRequest with some extra features like retry.
*
* Kinda implements the jQuery (http://api.jquery.com/jquery.ajax/) ajax options.
*
* @author Aart Röst / Cargo Collective
*
*/
Cargo.utils.CargoXHR = function(options){
var self = this;
$.extend(this.options = {}, this.defaultOptions, options);
if(this.options.context === undefined){
this.options.context = this;
}
if(this.options.url === undefined){
throw 'no URL given, define "url" in the contructor\'s options object';
}
this.retries = 0;
this.xhr = new XMLHttpRequest();
this.xhr.addEventListener("abort", function(){
self.options.abort.apply(self.options.context, arguments);
}, false);
this.xhr.addEventListener("error", function(){
self.options.error.apply(self.options.context, arguments);
}, false);
this.xhr.addEventListener("load", function(){
self.options.success.apply(self.options.context, arguments);
}, false);
this.xhr.addEventListener("loadend", function(){
self.options.always.apply(self.options.context, arguments);
}, false);
this.xhr.upload.addEventListener("progress", function(e){
self.options.progress.apply(self.options.context, arguments);
}, false);
this.send();
}
Cargo.utils.CargoXHR.prototype.send = function(){
this.xhr.open(this.options.type, this.options.url, this.options.async);
for(var key in this.options.headers){
this.xhr.setRequestHeader(key, this.options.headers[key]);
}
this.xhr.responseType = this.options.dataType;
this.options.beforeSend.call(this, this.xhr);
this.xhr.send(this.options.data);
}
Cargo.utils.CargoXHR.prototype.retry = function(){
if(this.retries++ < this.options.maxRetries){
Cargo.utils.CargoXHR.prototype.send.apply(this, arguments);
} else {
this.abort();
return false;
}
}
Cargo.utils.CargoXHR.prototype.abort = function(){
if(typeof this.xhr === 'object'){
this.xhr.abort();
}
}
Cargo.utils.CargoXHR.prototype.defaultOptions = {
async: true,
beforeSend: function(XHR){
},
always: function(e){
},
success: function(e){
},
progress: function(e){
},
error: function(e) {
},
abort: function(e) {
},
type: 'GET',
url: undefined,
dataType: 'text',
headers: {},
data: null,
context: undefined,
maxRetries: 5
}
Cargo.utils = Cargo.utils || {};
/**
* @todo: process fields: totalBytes, uploadedBytes
* global progress percentage calculated with the progress from all processes.
*
*/
Cargo.utils.ImageUploader = function(options){
$.extend(this.options = {}, this.defaultOptions, options);
this.activeProcesses = [];
}
Cargo.utils.ImageUploader.prototype = {
upload: function(files, pid, customParameters){
if(files === undefined){
return undefined;
}
// TODO: handle either a single file or an array of files
if(files.length === 0) {
return undefined;
};
var _this = this;
// wrap all files in a process. This allows for
// global progress tracking when uploading an array
// of files and easier management of multiple
// concurrent processes. Also allows you to swap out processes
// between uploader instances or re-upload/re-use a certain process.
var uploadProcess = {
uid: Cargo.Model.Site.GetId(),
url: Cargo.Helper.GetUrl(),
pid: (pid !== undefined ? pid : Cargo.Helper.GetCurrentProjectId()),
fileIndex: -1,
aborted: false,
totalBytes: 0,
uploadedBytes: 0,
customParameters: customParameters,
getUploadProgress: function(){
return (this.uploadedBytes / this.totalBytes) * 100;
},
files: [],
events: {
onFileComplete: function(file, event){},
onFileProgress: function(file, event){},
onFileFail: function(file, event){},
onFileError: function(file, event){},
onAbort: function(uploadProcess){},
onComplete: function(uploadProcess){}
},
getNextFile: function(){
if(this.fileIndex < this.files.length - 1 && this.aborted !== true){
return this.files[++this.fileIndex];
}
return undefined;
},
getCurrentFile: function(){
return this.files[this.fileIndex];
},
abort: function(){
if(this.xhr !== undefined){
this.aborted = true;
this.xhr.abort();
this.events.onAbort(this);
var processIndex = _this.activeProcesses.indexOf(this);
if(processIndex !== -1){
_this.activeProcesses.splice(processIndex, 1);
}
}
},
addFile: function(file){
if(this.files.indexOf(file) === -1) {
if(_this.options.acceptFileTypes.test(file.type) && _this.options.acceptFileTypes.test(file.name)){
uploadProcess.files.push(file);
this.totalBytes += file.size;
} else {
// TODO: Think this through again.
uploadProcess.events.onFileError(file, {
message: 'File type not allowed'
});
}
}
}
};
[].forEach.call(files, function(file){
uploadProcess.addFile(file);
});
if(uploadProcess.files.length === 0){
uploadProcess = null;
return undefined;
}
this.activeProcesses.push(uploadProcess);
this.handleUploadProcess(uploadProcess);
return uploadProcess;
},
handleUploadProcess: function(uploadProcess){
var file = uploadProcess.getNextFile(),
_this = this;
if(file === undefined) {
// no more files.
uploadProcess.xhr = undefined;
uploadProcess.events.onComplete(uploadProcess);
uploadProcess.fileIndex = -1;
var processIndex = _this.activeProcesses.indexOf(uploadProcess);
if(processIndex !== -1){
_this.activeProcesses.splice(processIndex, 1);
}
return;
}
file.lastProgress = 0;
var formData = new FormData();
formData.append('Filedata[]', file);
formData.append('pid', uploadProcess.pid);
formData.append('url', uploadProcess.url);
formData.append('uid', uploadProcess.uid);
if(typeof uploadProcess.customParameters === "object"){
Object.keys(uploadProcess.customParameters).forEach(function(key){
formData.append(key, uploadProcess.customParameters[key]);
});
}
uploadProcess.xhr = new Cargo.utils.CargoXHR({
url: this.options.posturl,
type: 'POST',
data: formData,
progress: function(e){
if(e.lengthComputable){
uploadProcess.uploadedBytes += e.loaded - file.lastProgress;
file.lastProgress = e.loaded;
}
uploadProcess.events.onFileProgress(file, e);
},
success: function(e){
if (this.xhr.status == 200) {
var response = JSON.parse(this.xhr.responseText);
uploadProcess.events.onFileComplete.call(this, file, e);
} else {
uploadProcess.events.onFileFail.call(this, file, e);
}
// keep going until we run out of files to upload
_this.handleUploadProcess(uploadProcess);
}
});
},
defaultOptions: {
acceptFileTypes: /(\.|\/)(gif|jpe?g|png)$/i,
posturl: '/dispatch/adminproject/handleMultiFileUpload'
}
};
/***************************************************************************
*
* Helper functions that are not in a class
*
* These are one off functions that do something, but are not tied
* to any particular class
*
**************************************************************************/
/**
* Replication of the php in_array function
* http://phpjs.org/functions/in_array/
*/
function in_array (needle, haystack, argStrict) {
var key = '',
strict = !! argStrict;
if (strict) {
for (key in haystack) {
if (haystack[key] === needle) {
return true;
}
}
} else {
for (key in haystack) {
if (haystack[key] == needle) {
return true;
}
}
}
return false;
}
/**
* Return the first letter of a word capitolized
*/
function ucFirst(str) {
return (str) ? str.charAt(0).toUpperCase() + str.slice(1) : str;
}
/**
* Legacy function
* CLoses projects
*/
function closeThisPr() {
Action.Project.Close();
}
/**
* Legacy function
* CLoses projects
*/
Projects = {
CloseProject :function() {
Action.Project.Close();
}
}
/**
* Legacy function
* Gets a filter
*/
Cargo.Location = {
GetUserFilter :function() {
// return Cargo.Model.Site.GetFilter();
return Cargo.API.Config.filter;
},
GetDomainOrUrl : function() {
return Cargo.Helper.GetUrl();
}
}
/**
* Legacy function
* Loads the inspector
*/
function loadInspector() {
Cargo.Core.LoadInspector();
}
/**
* Toggles the header into hi-res our out
* Called from the admin frame
*/
function ToggleHeaderHiRes(which, url, firstval) {
if($('img[src$="/'+url+'"]').length > 0) {
if(which == "2x") {
if(firstval == "2x") {
$('img[src$="/'+url+'"]').width( $('img[src$="/'+url+'"]').attr('width') );
$('img[src$="/'+url+'"]').height( $('img[src$="/'+url+'"]').attr('height') );
} else {
$('img[src$="/'+url+'"]').width( Math.floor($('img[src$="/'+url+'"]').attr('width') / 2) );
$('img[src$="/'+url+'"]').height( Math.floor($('img[src$="/'+url+'"]').attr('height') / 2) );
}
} else {
if(firstval == "1x") {
$('img[src$="/'+url+'"]').width( $('img[src$="/'+url+'"]').attr('width') );
$('img[src$="/'+url+'"]').height( $('img[src$="/'+url+'"]').attr('height') );
} else {
$('img[src$="/'+url+'"]').width( Math.floor($('img[src$="/'+url+'"]').attr('width') * 2) );
$('img[src$="/'+url+'"]').height( Math.floor($('img[src$="/'+url+'"]').attr('height') * 2) );
}
}
}
}
/**
* Social media class
*
* This is the main social media function
* It will init the rest of the application
*
* Cargo.IncludeSocialMedia( {
* element : ".project_footer",
* show_count : true,
*
* facebook : true,
* twitter : true,
* stumbleupon : false,
* pintrest : true
* } );
*
*
* .social_media {
* margin: 30px 0 100px 0; height: 20px;
* }
*
*/
Cargo.IncludeSocialMedia = function( dataObj ) {
// Loop through each to set the default options
$.each(dataObj, function(key, value) {
Cargo.Core.SocialMedia.SetDefaults(key, value);
});
// Set the project open/ready states
$(document).ready(function() {
Cargo.Core.SocialMedia.Init();
});
Cargo.Event.on('project_load_complete', function( pid ) {
Cargo.Core.SocialMedia.Init();
});
Cargo.Event.on('pagination_complete', function( new_page ) {
Cargo.Core.SocialMedia.Init();
});
};
/**
* Legacy function
* Smothly scroll
*/
var lastT = 0;
var timer = null;
function doscroll(targetYPos,y,t) {
var speed = 6;
var diff = targetYPos - y;
var steps = diff/(speed*speed);
t += (t+steps)/diff;
newY = (t==1) ? y+diff : y + (diff * (-Math.pow(2, -20 * t/1) + 1));
if(t) window.scrollTo(0, newY);
if(t >= 1 || lastT == t || !t) clearTimeout(timer);
else timer=setTimeout("doscroll("+targetYPos+","+y+","+t+")",1);
lastT = t;
return false;
}
function doscroll_left(targetXPos,x,t,scroll_obj) {
var speed = 6;
var diff = targetXPos - x;
var steps = diff/(speed*speed);
t += (t+steps)/diff;
newX = (t==1) ? x+diff : x + (diff * (-Math.pow(2, -20 * t/1) + 1));
if(t) {
if(scroll_obj === window) {
window.scrollTo(newX, 0);
} else {
scroll_obj.scrollLeft = newX;
}
}
if(t >= 1 || lastT == t || !t) clearTimeout(timer);
else timer=setTimeout(function() {
doscroll_left(targetXPos,x,t,scroll_obj);
},1);
lastT = t;
return false;
}
/**
* Legacy function to add a script into the head
* Used by tracemarks
*/
function addScript(script_file, id) {
script_file = (script_file == "/_js/cargo.tracemarklet.js") ? "/_js/cargo.tracemarklet-api.js" : script_file;
var scrpt=document.createElement('script');
scrpt.setAttribute('type','text/javascript');
scrpt.setAttribute('src',script_file);
if( id ) scrpt.setAttribute('id',id);
var hd=document.getElementsByTagName('head')[0];
hd.appendChild(scrpt);
}
/**
* Legacy function for adding Facebook comments
*
*/
/////////////////////////////////////////////////////////////////////////////////////////////////
// Facebook comments
function fbComments(variant, fbwidth, fbnum){
addScript("http://connect.facebook.net/en_US/all.js#xfbml=1");
var f_url =
padding = "";
var margin = "30px 0 30px 0";
var colorscheme = (variant == "dark") ? "dark" : "light";
fbwidth = (!fbwidth) ? 560 : fbwidth;
fbnum = (!fbnum) ? 15 : fbnum;
Cargo.Event.on("project_load_complete", function( pid ) {
fbCommentLoad(pid, variant, fbwidth, fbnum);
});
}
/////////////////////////////////////////////////////////////////////////////////////////////////
// Load FaceBook comments for non-feed designs
function fbCommentLoad(pid, variant, fbwidth, fbnum) {
var margin = "30px 0 30px 0";
var timeout = 500;
var colorscheme = (variant == "dark") ? "dark" : "light";
var position = "before";
var element= $("directlink",Cargo.View.ProjectDetail.$el);
if( !pid ) {
// get the open project
if( $("#current_open").length > 0 && $("#current_open").val() != "none") {
pid = $("#current_open").val();
} else {
return false;
}
}
// If you're on a project
if(Cargo.Model.Project.GetType() == "project"){
// Load the Facebook comments script again, for whatever reason(s)
$.getScript("http://connect.facebook.net/en_US/all.js#xfbml=1", function() {
var f_url = Cargo.Model.Project.GetDirectLink();
if(position == "after") {
$(element).after('