Project prompt

# HG changeset patch # User ymh # Date 1356467351 -3600 # Node ID 267d67791e05b1e60b8fcbe538d409bf4600b02a # Parent 7e132e2a48ca5b3dce61dcd7bbd1b3657443e84b first stabilization of editing a renkan. No collaborative capacities yet. diff -r 7e132e2a48ca -r 267d67791e05 .classpath --- a/.classpath Tue Dec 11 00:01:41 2012 +0100 +++ b/.classpath Tue Dec 25 21:29:11 2012 +0100 @@ -9,21 +9,21 @@ - - - + + + - - + + - + - + @@ -32,9 +32,11 @@ - - + + + - + + diff -r 7e132e2a48ca -r 267d67791e05 server/pom.xml --- a/server/pom.xml Tue Dec 11 00:01:41 2012 +0100 +++ b/server/pom.xml Tue Dec 25 21:29:11 2012 +0100 @@ -8,10 +8,11 @@ war - 0.8.3.1 - 1.14 - 3.1.2.RELEASE - 4.10 + 0.8.4 + 1.16 + 3.1.3.RELEASE + 4.10 + 2.0.14 UTF-8 @@ -154,6 +155,14 @@ org.springframework spring-core + + org.springframework + spring-web + + + org.springframework + spring-aop + @@ -187,6 +196,11 @@ ${spring-version} + org.springframework + spring-webmvc + ${spring-version} + + org.springframework.data spring-data-commons-core 1.4.0.RELEASE @@ -209,9 +223,35 @@ junit junit - ${junit.version} + ${junit-version} test - + + + javax.servlet + jstl + 1.2 + runtime + + + org.thymeleaf + thymeleaf + ${thymeleaf-version} + + + org.thymeleaf + thymeleaf-spring3 + ${thymeleaf-version} + + + net.sourceforge.nekohtml + nekohtml + 1.9.16 + + + com.fasterxml.jackson.jaxrs + jackson-jaxrs-json-provider + 2.1.2 + IRI diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/controller/RenkanController.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/java/org/iri_research/renkan/controller/RenkanController.java Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,64 @@ +package org.iri_research.renkan.controller; + +import java.util.HashMap; +import java.util.Map; + +import org.iri_research.renkan.models.Project; +import org.iri_research.renkan.repositories.ProjectsRepository; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.web.HttpMediaTypeNotAcceptableException; +import org.springframework.web.HttpMediaTypeNotSupportedException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.servlet.ModelAndView; + + +@Controller +@RequestMapping("/") +public class RenkanController { + + private final Logger logger = LoggerFactory.getLogger(RenkanController.class); + + @Autowired + private ProjectsRepository projectRepository; + + @RequestMapping(value="/{project_id}", method = RequestMethod.GET, produces={"text/html", "!image/*"}) + public ModelAndView renkanProject(@PathVariable(value="project_id") String project_id, @RequestHeader(value="Accept") String accept_header) throws HttpMediaTypeNotSupportedException { + + this.logger.debug("renkanProject : " + project_id + " Accept : " + accept_header!=null?accept_header:""); + + if(accept_header != null && accept_header.matches(".*image/.*")) { + throw new HttpMediaTypeNotSupportedException("Do not orduce image"); + } + + if(project_id == null || project_id.length() == 0) { + throw new IllegalArgumentException("RenkanContoller.renkanProject: Project id is null or empty."); + } + + Project project = this.projectRepository.findOne(project_id); + + if(project == null) { + project = new Project(project_id, "(New project)", "(Project Description)", ""); + this.projectRepository.save(project); + } + + Map model = new HashMap(); + model.put("project", project); + + return new ModelAndView("renkanProjectEdit", model); + } + + /*@RequestMapping("/test") + public ModelAndView projectPrompt() { + String message = "Hello world, Spring"; + + return new ModelAndView("projectPrompt", "message", message); + }*/ + +} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/coweb/RenkanSessionModerator.java --- a/server/src/main/java/org/iri_research/renkan/coweb/RenkanSessionModerator.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/coweb/RenkanSessionModerator.java Tue Dec 25 21:29:11 2012 +0100 @@ -19,7 +19,7 @@ @SuppressWarnings("unchecked") @Override - public boolean onSync(Map data) { + public void onSync(Map data) { this.logger.debug("Debugging onSync : " + data.toString()); this.logger.debug("Debugging onSync channel: " + data.get("channel")); @@ -35,28 +35,27 @@ if(values == null) { this.logger.warn("onSync : no values in message."); - return super.onSync(data); + return; } - String sync_type = (String) values.get("type"); + String sync_type = (String) values.get("_type"); if(sync_type == null || sync_type.length() == 0) { this.logger.warn("onSync : no type in value of message."); - return super.onSync(data); + return; } ApplicationContext context = SpringConfigurer.getInstance().getApplicationContext(); //String className = String.format("org.iri_research.renkan.coweb.event.%sSyncEventManager", sync_type.substring(0, 1).toUpperCase()+sync_type.substring(1)); String beanName = String.format("%sSyncEventManager", sync_type.toLowerCase()); - boolean resDispatch = false; try { - ISyncEventManager eventManager = (ISyncEventManager)context.getBean(beanName); + ISyncEventManager eventManager = (ISyncEventManager)context.getBean(beanName); logger.debug("Debugging on Sync : dispatch to " + beanName); - resDispatch = eventManager.dispatchEvent(data); + eventManager.dispatchEvent(data); } catch(Throwable e) { - this.logger.error(String.format("onSync EventManagerClass %s not found : error : %s", sync_type, e.getMessage())); + this.logger.error(String.format("onSync EventManagerClass %s not found : error %s : %s", sync_type, e.toString(), e.getMessage())); } /*catch (ClassNotFoundException e) { this.logger.error(String.format("onSync EventManagerClass %s not found : ClassNotFoundException : %s", sync_type, e.getMessage())); @@ -66,7 +65,6 @@ this.logger.error(String.format("onSync EventManagerClass %s not found : IllegalAccessException : %s", sync_type, e.getMessage())); }*/ - return super.onSync(data) && resDispatch; } } diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/coweb/event/AbstractSyncEventManager.java --- a/server/src/main/java/org/iri_research/renkan/coweb/event/AbstractSyncEventManager.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/coweb/event/AbstractSyncEventManager.java Tue Dec 25 21:29:11 2012 +0100 @@ -1,19 +1,29 @@ package org.iri_research.renkan.coweb.event; +import java.io.Serializable; +import java.util.List; import java.util.Map; import javax.inject.Inject; +import org.coweb.CowebException; import org.iri_research.renkan.RenkanException; +import org.iri_research.renkan.models.IRenkanModel; import org.iri_research.renkan.models.Project; import org.iri_research.renkan.models.ProjectSync; +import org.iri_research.renkan.repositories.IRenkanRepository; import org.iri_research.renkan.repositories.ProjectSyncsRepository; import org.iri_research.renkan.repositories.ProjectsRepository; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import com.mongodb.BasicDBObject; +import com.mongodb.DBCollection; +import com.mongodb.DBObject; +import com.mongodb.WriteResult; -public abstract class AbstractSyncEventManager implements ISyncEventManager { + +public abstract class AbstractSyncEventManager, ID extends Serializable> implements ISyncEventManager { private final Logger logger = LoggerFactory.getLogger(AbstractSyncEventManager.class); @@ -27,29 +37,32 @@ public ProjectsRepository getProjectsRepository() { return this.projectsRepository; } + + @Override + public abstract IRenkanRepository getObjectRepository(); @Override - public boolean dispatchEvent(Map data) { + public void dispatchEvent(Map data) { this.saveSyncEvent(data); String eventType = (String) data.get("type"); if("null".equalsIgnoreCase(eventType)) { - return this.nullOperation(data); + this.nullOperation(data); } else if ("update".equalsIgnoreCase(eventType)) { - return this.update(data); + this.update(data); } else if ("insert".equalsIgnoreCase(eventType)) { - return this.insert(data); + this.insert(data); } else if("delete".equalsIgnoreCase(eventType)) { - return this.delete(data); + this.delete(data); } - - logger.warn(String.format("dispatchEvent : eventType unknown %s", eventType)); - return false; + else { + logger.warn(String.format("dispatchEvent : eventType unknown %s", eventType)); + } } private void saveSyncEvent(Map data) { @@ -60,7 +73,7 @@ Map values = (Map) data.get("value"); if(values != null) { - project_id = (String) values.get("project_id"); + project_id = (String) values.get("_project_id"); } if (project_id == null || "".equals(project_id)) { @@ -85,16 +98,109 @@ } - @Override - public abstract boolean update(Map data); + protected abstract List getObjectList(Project project); @Override - public abstract boolean insert(Map data); + public void update(Map data) { + + this.logger.debug("AbstractSyncEventManager: update " + this.getClass().getName()); + + @SuppressWarnings("unchecked") + Map values = (Map) data.get("value"); + String obj_id = (String) values.get("id"); + + this.logger.debug(String.format("update %s %s", this.getClass().getName(), obj_id)); + + DBCollection objCollection = this.getObjectRepository().getCollection(); + DBObject obj = objCollection.findOne(obj_id); + + if (null == obj) { + throw new CowebException("Object update: object not found", String.format("Object %s not found in %s", obj_id, objCollection.getName())); + } + + boolean obj_changed = false; + // update object + for (String fieldname : values.keySet()) { + if(!"id".equalsIgnoreCase(fieldname) && !fieldname.startsWith("_")) + { + Object new_value = values.get(fieldname); + Object old_value = obj.get(fieldname); + if((new_value == null && old_value != null) || (new_value != null && !new_value.equals(old_value))) { + obj.put(fieldname, new_value); + obj_changed = true; + } + } + } + + if(obj_changed) { + obj.put("_id", obj_id); + WriteResult res = this.getObjectRepository().getCollection().update(new BasicDBObject("_id", obj_id), obj, true, false); + + if(!res.getLastError().ok()) { + throw new CowebException(String.format("Error when writing object %s in %s", obj_id, objCollection.getName()), res.getLastError().getErrorMessage()); + } + } + } + + @Override + public abstract void insert(Map data); @Override - public abstract boolean delete(Map data); + public void delete(Map data) { + + @SuppressWarnings("unchecked") + Map values = (Map) data.get("value"); + String project_id = (String) values.get("_project_id"); + Project project = this.getProjectsRepository().findOne(project_id); + + if (null == project) { + throw new CowebException(this.getClass().getName() + " delete: project not found", String.format("Project %s not found", project_id)); + } + + Integer position = (Integer)data.get("position"); + + if(position == null || position < 0) { + throw new CowebException("object delete: bad delete position", String.format("Bad position %s not found", position==null?"null":position.toString())); + } + int index = position.intValue(); + + @SuppressWarnings("unchecked") + ID object_id = (ID) values.get("id"); + + this.logger.debug(String.format("delete object %s in pos %d for project %s", object_id, index, project_id)); + + IRenkanModel currentObject = null; + + List objList = this.getObjectList(project); + + if(index < objList.size()) { + currentObject = objList.get(index); + } + + if(currentObject == null || !object_id.equals(currentObject.getId())) { + index = -1; + this.logger.warn(String.format("delete object %s in pos %d for project %s not current object", object_id, index, project_id)); + for(int i=0;i data); - + public abstract void nullOperation(Map data); + + } diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/coweb/event/EdgeSyncEventManager.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/java/org/iri_research/renkan/coweb/event/EdgeSyncEventManager.java Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,118 @@ +package org.iri_research.renkan.coweb.event; + +import java.util.List; +import java.util.Map; + +import javax.inject.Inject; +import javax.inject.Named; + +import org.coweb.CowebException; +import org.iri_research.renkan.models.Edge; +import org.iri_research.renkan.models.Node; +import org.iri_research.renkan.models.Project; +import org.iri_research.renkan.repositories.EdgesRepository; +import org.iri_research.renkan.repositories.IRenkanRepository; +import org.iri_research.renkan.repositories.NodesRepository; +import org.iri_research.renkan.repositories.UsersRepository; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Named +public class EdgeSyncEventManager extends AbstractSyncEventManager { + + private final Logger logger = LoggerFactory.getLogger(EdgeSyncEventManager.class); + + @Inject + private NodesRepository nodesRepository; + + @Inject + private UsersRepository usersRepository; + + @Inject + private EdgesRepository edgesRepository; + + + public NodesRepository getNodesRepository() { + return nodesRepository; + } + + public UsersRepository getUsersRepository() { + return usersRepository; + } + + public EdgesRepository getEdgesRepository() { + return edgesRepository; + } + + + @Override + public IRenkanRepository getObjectRepository() { + return this.getEdgesRepository(); + } + + + @Override + public void insert(Map data) { + + // get project + this.logger.debug("NodeSyncEventManager: insert Node"); + + @SuppressWarnings("unchecked") + Map values = (Map) data.get("value"); + String project_id = (String) values.get("_project_id"); + + Project project = this.getProjectsRepository().findOne(project_id); + + if (null == project) { + throw new CowebException("node insert: project not found", String.format("Project %s not found", project_id)); + } + + String creator_id = (String) values.get("created_by"); + + String from_node_id = (String)values.get("from"); + Node from_node = this.getNodesRepository().findOne(from_node_id); + + if(null == from_node) { + throw new CowebException("Edge insert: from not found", String.format("from %s not found", from_node_id)); + } + + String to_node_id = (String)values.get("to"); + Node to_node = this.getNodesRepository().findOne(to_node_id); + + if(null == to_node) { + throw new CowebException("Edge insert: to not found", String.format("to %s not found", to_node_id)); + } + + String edge_id = (String)values.get("id"); + + Edge edge = new Edge(edge_id, (String)values.get("title"), (String)values.get("description"), (String)values.get("uri"), from_node, to_node, creator_id, project_id); + + + Integer position = (Integer)data.get("position"); + + if(position == null || position < 0) { + throw new CowebException("node insert: bad insert position", String.format("Bad position %s not found", position==null?"null":position.toString())); + } + int index = position.intValue(); + List edges = project.getEdges(); + if(index > edges.size()) { + index = edges.size(); + } + edges.add(index,edge); + + this.getEdgesRepository().save(edge); + this.getProjectsRepository().save(project); + + } + + @Override + public void nullOperation(Map data) { + this.logger.debug("nullOperation: NOP"); + } + + @Override + protected List getObjectList(Project project) { + return project.getEdges(); + } + +} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/coweb/event/ISyncEventManager.java --- a/server/src/main/java/org/iri_research/renkan/coweb/event/ISyncEventManager.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/coweb/event/ISyncEventManager.java Tue Dec 25 21:29:11 2012 +0100 @@ -1,18 +1,21 @@ package org.iri_research.renkan.coweb.event; +import java.io.Serializable; import java.util.Map; +import org.iri_research.renkan.repositories.IRenkanRepository; import org.iri_research.renkan.repositories.ProjectsRepository; -public interface ISyncEventManager { +public interface ISyncEventManager { - public boolean dispatchEvent(Map data); + public void dispatchEvent(Map data); - public boolean update(Map data); - public boolean insert(Map data); - public boolean delete(Map data); - public boolean nullOperation(Map data); + public void update(Map data); + public void insert(Map data); + public void delete(Map data); + public void nullOperation(Map data); public ProjectsRepository getProjectsRepository(); + public IRenkanRepository getObjectRepository(); } diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/coweb/event/NodeSyncEventManager.java --- a/server/src/main/java/org/iri_research/renkan/coweb/event/NodeSyncEventManager.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/coweb/event/NodeSyncEventManager.java Tue Dec 25 21:29:11 2012 +0100 @@ -9,92 +9,67 @@ import org.coweb.CowebException; import org.iri_research.renkan.models.Node; import org.iri_research.renkan.models.Project; -import org.iri_research.renkan.models.ProjectRevision; +import org.iri_research.renkan.repositories.IRenkanRepository; import org.iri_research.renkan.repositories.NodesRepository; +import org.iri_research.renkan.repositories.UsersRepository; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - -import com.mongodb.BasicDBObject; -import com.mongodb.DBCollection; -import com.mongodb.DBObject; -import com.mongodb.WriteResult; +import org.springframework.data.mongodb.core.geo.Point; @Named -public class NodeSyncEventManager extends AbstractSyncEventManager { +public class NodeSyncEventManager extends AbstractSyncEventManager { - private final Logger logger = LoggerFactory.getLogger(ProjectSyncEventManager.class); + private final Logger logger = LoggerFactory.getLogger(NodeSyncEventManager.class); @Inject private NodesRepository nodesRepository; - + + @Inject + private UsersRepository usersRepository; + public NodesRepository getNodesRepository() { return nodesRepository; } - + @Override - public boolean update(Map data) { + public IRenkanRepository getObjectRepository() { + return this.getNodesRepository(); + } + + public UsersRepository getUsersRepository() { + return this.usersRepository; + } - this.logger.debug("ProjectSyncEventManager: update project"); + + @Override + public void insert(Map data) { + + // get project + this.logger.debug("NodeSyncEventManager: insert Node"); @SuppressWarnings("unchecked") Map values = (Map) data.get("value"); - String node_id = (String) values.get("id"); - - this.logger.debug(String.format("update node %s", node_id)); - - DBCollection projectCollection = this.getNodesRepository().getCollection(); - DBObject node = projectCollection.findOne(node_id); - - if (null == node) { - throw new CowebException("Node update: node not found", String.format("Node %s not found", node_id)); - } - - boolean node_changed = false; - // update project - for (String fieldname : values.keySet()) { - if(!"id".equalsIgnoreCase(fieldname) && node.containsField(fieldname)) - { - Object new_value = values.get(fieldname); - Object old_value = node.get(fieldname); - if((new_value == null && old_value != null) || (new_value != null && !new_value.equals(old_value))) { - node.put(fieldname, new_value); - node_changed = true; - } - } - } - - if(node_changed) { - node.put("_id", node_id); - WriteResult res = this.getNodesRepository().getCollection().update(new BasicDBObject("_id", node_id), node, true, false); - - if(!res.getLastError().ok()) { - throw new CowebException(String.format("Error when writing node %s", node_id), res.getLastError().getErrorMessage()); - } - } + String project_id = (String) values.get("_project_id"); - return false; - } - - @Override - public boolean insert(Map data) { - - // get project - this.logger.debug("ProjectSyncEventManager: update project"); - - @SuppressWarnings("unchecked") - Map values = (Map) data.get("value"); - String project_id = (String) values.get("project_id"); - - Project project = this.getProjectsRepository().findOne(project_id); - + Project project = this.getProjectsRepository().findOne(project_id); + if (null == project) { throw new CowebException("node insert: project not found", String.format("Project %s not found", project_id)); } + String creator_id = (String) values.get("created_by"); + + @SuppressWarnings("unchecked") + Map positionValues = (Map) values.get("position"); + + Point nodePosition = new Point(((Number)positionValues.get("x")).doubleValue(), ((Number)positionValues.get("y")).doubleValue()); + + String image = (String)values.get("image"); + String node_id = (String)values.get("id"); - Node node = new Node(node_id, (String)values.get("id"), (String)values.get("description"), (String)values.get("uri"), project); + Node node = new Node(node_id, (String)values.get("title"), (String)values.get("description"), (String)values.get("uri"), project_id, creator_id, nodePosition, image); Integer position = (Integer)data.get("position"); @@ -111,20 +86,16 @@ this.getNodesRepository().save(node); this.getProjectsRepository().save(project); - return false; + } + + @Override + public void nullOperation(Map data) { + this.logger.debug("nullOperation: NOP"); } @Override - public boolean delete(Map data) { - - - return false; - } - - @Override - public boolean nullOperation(Map data) { - this.logger.debug("nullOperation: NOP"); - return false; + protected List getObjectList(Project project) { + return project.getNodes(); } } diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/coweb/event/ProjectSyncEventManager.java --- a/server/src/main/java/org/iri_research/renkan/coweb/event/ProjectSyncEventManager.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/coweb/event/ProjectSyncEventManager.java Tue Dec 25 21:29:11 2012 +0100 @@ -3,105 +3,62 @@ */ package org.iri_research.renkan.coweb.event; +import java.util.List; import java.util.Map; import javax.inject.Named; -import org.coweb.CowebException; +import org.iri_research.renkan.models.Project; +import org.iri_research.renkan.repositories.IRenkanRepository; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.mongodb.BasicDBObject; -import com.mongodb.DBCollection; -import com.mongodb.DBObject; -import com.mongodb.WriteResult; - /** * @author ymh * */ @Named -public class ProjectSyncEventManager extends AbstractSyncEventManager { +public class ProjectSyncEventManager extends AbstractSyncEventManager { - private final Logger logger = LoggerFactory.getLogger(ProjectSyncEventManager.class); - - private DBCollection getCollection() { - return this.getProjectsRepository().getCollection(); + private final Logger logger = LoggerFactory.getLogger(ProjectSyncEventManager.class); + + @Override + public IRenkanRepository getObjectRepository() { + return this.getProjectsRepository(); } - /* Update a project - * @see org.iri_research.renkan.coweb.event.AbstractSyncEventManager#update(java.util.Map) - */ - @Override - public boolean update(Map data) { - - this.logger.debug("ProjectSyncEventManager: update project"); - - @SuppressWarnings("unchecked") - Map values = (Map) data.get("value"); - String project_id = (String) values.get("id"); - - // get project - this.logger.debug(String.format("update project %s", project_id)); - - DBCollection projectCollection = this.getCollection(); - DBObject project = projectCollection.findOne(project_id); - - if (null == project) { - throw new CowebException("Project update: project not found", String.format("Project %s not found", project_id)); - } - - boolean project_changed = false; - // update project - for (String fieldname : values.keySet()) { - if(!"id".equalsIgnoreCase(fieldname) && project.containsField(fieldname)) - { - Object new_value = values.get(fieldname); - Object old_value = project.get(fieldname); - if((new_value == null && old_value != null) || (new_value != null && !new_value.equals(old_value))) { - project.put(fieldname, new_value); - project_changed = true; - } - } - } - - if(project_changed) { - project.put("_id", project_id); - WriteResult res = projectCollection.update(new BasicDBObject("_id", project_id), project, true, false); - - if(!res.getLastError().ok()) { - throw new CowebException(String.format("Error when writing project %s", project_id), res.getLastError().getErrorMessage()); - } - - } - return false; - } - /* (non-Javadoc) * @see org.iri_research.renkan.coweb.event.AbstractSyncEventManager#insert(java.util.Map) */ @Override - public boolean insert(Map data) { + public void insert(Map data) { + this.logger.debug("Insert called, do nothing"); // do nothing - return false; } /* (non-Javadoc) * @see org.iri_research.renkan.coweb.event.AbstractSyncEventManager#delete(java.util.Map) */ @Override - public boolean delete(Map data) { + public void delete(Map data) { + this.logger.debug("Delete called, do nothing"); // do nothing - return false; } /* (non-Javadoc) * @see org.iri_research.renkan.coweb.event.AbstractSyncEventManager#nullOperation(java.util.Map) */ @Override - public boolean nullOperation(Map data) { + public void nullOperation(Map data) { + this.logger.debug("Null called, do nothing"); // do nothing - return false; } + @Override + protected List getObjectList(Project project) { + this.logger.error("Get object list called error"); + throw new UnsupportedOperationException("Get object list called error"); + } + + } diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/coweb/event/UserSyncEventManager.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/java/org/iri_research/renkan/coweb/event/UserSyncEventManager.java Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,88 @@ +package org.iri_research.renkan.coweb.event; + +import java.util.List; +import java.util.Map; + +import javax.inject.Inject; +import javax.inject.Named; + +import org.coweb.CowebException; +import org.iri_research.renkan.models.Project; +import org.iri_research.renkan.models.User; +import org.iri_research.renkan.repositories.IRenkanRepository; +import org.iri_research.renkan.repositories.UsersRepository; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Named +public class UserSyncEventManager extends AbstractSyncEventManager { + + private final Logger logger = LoggerFactory.getLogger(UserSyncEventManager.class); + + private final static String DEFAULT_COLOR = "#000080"; + + @Inject + private UsersRepository usersRepository; + + public UsersRepository getUsersRepository() { + return this.usersRepository; + } + + @Override + public IRenkanRepository getObjectRepository() { + return this.getUsersRepository(); + } + + + @Override + public void insert(Map data) { + + // get project + this.logger.debug("UserSyncEventManager: insert User"); + + @SuppressWarnings("unchecked") + Map values = (Map) data.get("value"); + String project_id = (String) values.get("_project_id"); + + Project project = this.getProjectsRepository().findOne(project_id); + + if (null == project) { + throw new CowebException("user insert: project not found", String.format("Project %s not found", project_id)); + } + + String user_id = (String)values.get("id"); + String color = (String)values.get("color"); + if(color == null || color.length() == 0) { + color = UserSyncEventManager.DEFAULT_COLOR; + } + + User user = new User(user_id, (String)values.get("title"), (String)values.get("description"), (String)values.get("uri"), color, project_id); + + Integer position = (Integer)data.get("position"); + + if(position == null || position < 0) { + throw new CowebException("node insert: bad insert position", String.format("Bad position %s not found", position==null?"null":position.toString())); + } + int index = position.intValue(); + List users = project.getUsers(); + if(index > users.size()) { + index = users.size(); + } + users.add(index,user); + + this.getUsersRepository().save(user); + this.getProjectsRepository().save(project); + + } + + @Override + public void nullOperation(Map data) { + this.logger.debug("nullOperation: NOP"); + } + + @Override + protected List getObjectList(Project project) { + return project.getUsers(); + } + +} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/models/Edge.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/java/org/iri_research/renkan/models/Edge.java Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,57 @@ +package org.iri_research.renkan.models; + +import org.springframework.data.mongodb.core.mapping.DBRef; +import org.springframework.data.mongodb.core.mapping.Document; + + +@Document(collection="edges") +public class Edge extends AbstractRenkanModel { + + @DBRef + private Node from; + + @DBRef + private Node to; + + private String project_id; + + private String created_by; + + + public Edge(String id, String title, String description, String uri, Node from, Node to, String created_by, String project_id) { + super(id,title, description, uri); + this.from = from; + this.to = to; + this.created_by = created_by; + this.project_id = project_id; + } + + + public String getProject_id() { + return project_id; + } + + + public String getCreated_by() { + return created_by; + } + + public String getFrom() { + if(this.from != null) { + return this.from.id; + } + else { + return null; + } + } + + public String getTo() { + if(this.to != null) { + return this.to.id; + } + else { + return null; + } + } + +} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/models/Node.java --- a/server/src/main/java/org/iri_research/renkan/models/Node.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/models/Node.java Tue Dec 25 21:29:11 2012 +0100 @@ -1,19 +1,43 @@ package org.iri_research.renkan.models; -import org.springframework.data.mongodb.core.mapping.DBRef; +import org.springframework.data.mongodb.core.geo.Point; import org.springframework.data.mongodb.core.mapping.Document; @Document(collection="nodes") public class Node extends AbstractRenkanModel { - public Node(String id, String title, String description, String uri, Project project) { + public Node(String id, String title, String description, String uri, String project_id, String created_by, Point position, String image) { super(id, title, description, uri); - this.project = project; + this.project_id = project_id; + this.created_by = created_by; + this.position = position; + this.image = image; } - @DBRef - private Project project = null; + private String project_id = null; + + private String created_by = null; + + private Point position = null; + + public Point getPosition() { + return position; + } + + private String image; + + public String getImage() { + return image; + } + + public String getProject_id() { + return project_id; + } + + public String getCreated_by() { + return created_by; + } } diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/models/Project.java --- a/server/src/main/java/org/iri_research/renkan/models/Project.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/models/Project.java Tue Dec 25 21:29:11 2012 +0100 @@ -20,10 +20,15 @@ @DBRef private List nodes = new ArrayList(); - // Relations + // edges @DBRef - private List relations = new ArrayList(); + private List edges = new ArrayList(); + // Users + @DBRef + private List users = new ArrayList(); + + public Project(String id, String title, String description, String uri, int revCounter) { @@ -40,16 +45,19 @@ } public int getRevCounter() { - return revCounter; + return this.revCounter; } public List getNodes() { - return nodes; + return this.nodes; } - public List getRelations() { - return relations; - } - + public List getEdges() { + return this.edges; + } + + public List getUsers() { + return this.users; + } } diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/models/ProjectRevision.java --- a/server/src/main/java/org/iri_research/renkan/models/ProjectRevision.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/models/ProjectRevision.java Tue Dec 25 21:29:11 2012 +0100 @@ -26,8 +26,8 @@ // Nodes private List nodes = new ArrayList(); - // Relations - private List relations = new ArrayList(); + // Edgess + private List edges = new ArrayList(); @SuppressWarnings("unused") @@ -57,8 +57,8 @@ return nodes; } - public List getRelations() { - return relations; + public List getEgdes() { + return edges; } public Date getCreated() { diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/models/Relation.java --- a/server/src/main/java/org/iri_research/renkan/models/Relation.java Tue Dec 11 00:01:41 2012 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,27 +0,0 @@ -package org.iri_research.renkan.models; - -import org.bson.types.ObjectId; -import org.springframework.data.mongodb.core.mapping.DBRef; -import org.springframework.data.mongodb.core.mapping.Document; - - -@Document(collection="relations") -public class Relation extends AbstractRenkanModel { - - @DBRef - private Node srcNode; - - @DBRef - private Node tgtNode; - - @DBRef - private Project project; - - public Relation(ObjectId id, String title, String description, String uri, Node srcNode, Node tgtNode, Project project) { - super(id,title, description, uri); - this.srcNode = srcNode; - this.tgtNode = tgtNode; - this.project = project; - } - -} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/models/User.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/java/org/iri_research/renkan/models/User.java Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,27 @@ +package org.iri_research.renkan.models; + +import org.springframework.data.mongodb.core.mapping.Document; + +@Document(collection="users") +public class User extends AbstractRenkanModel { + + private String color; + + private String project_id; + + public User(String id, String title, String description, String uri, String color, String project_id) { + super(id, title, description, uri); + + this.project_id = project_id; + this.color = color; + } + + public String getColor() { + return this.color; + } + + public String getProject_id() { + return project_id; + } + +} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/repositories/EdgesRepository.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/java/org/iri_research/renkan/repositories/EdgesRepository.java Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,7 @@ +package org.iri_research.renkan.repositories; + +import org.iri_research.renkan.models.Edge; + +public interface EdgesRepository extends IRenkanRepository { + +} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/repositories/RelationsRepository.java --- a/server/src/main/java/org/iri_research/renkan/repositories/RelationsRepository.java Tue Dec 11 00:01:41 2012 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,7 +0,0 @@ -package org.iri_research.renkan.repositories; - -import org.iri_research.renkan.models.Relation; - -public interface RelationsRepository extends IRenkanRepository { - -} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/repositories/UsersRepository.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/java/org/iri_research/renkan/repositories/UsersRepository.java Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,7 @@ +package org.iri_research.renkan.repositories; + +import org.iri_research.renkan.models.User; + +public interface UsersRepository extends IRenkanRepository { + +} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/java/org/iri_research/renkan/rest/ProjectsResource.java --- a/server/src/main/java/org/iri_research/renkan/rest/ProjectsResource.java Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/java/org/iri_research/renkan/rest/ProjectsResource.java Tue Dec 25 21:29:11 2012 +0100 @@ -19,6 +19,7 @@ import javax.ws.rs.core.Response.Status; import javax.ws.rs.core.UriInfo; +import org.iri_research.renkan.models.Project; import org.iri_research.renkan.repositories.ProjectsRepository; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -54,18 +55,17 @@ @GET @Path("{id : [a-zA-Z\\-0-9]+}") @Produces(MediaType.APPLICATION_JSON + ";charset=utf-8") - public String getProject(@PathParam("id") String projectId) { + public Project getProjectSd(@PathParam("id") String projectId) { - this.logger.debug("GetProject : id " + projectId); + this.logger.debug("GetProject: " + projectId); - DBCollection projectCollection = this.getCollection(); - DBObject project = projectCollection.findOne(projectId); + Project project = this.projectRepository.findOne(projectId); if (null == project) { throw new WebApplicationException(Status.NOT_FOUND); } - return project.toString(); + return project; } @DELETE @@ -74,21 +74,10 @@ public Response deleteProject(@PathParam("id") String projectId) { this.logger.debug("DeleteProject : id " + projectId); - DBCollection projectCollection = this.getCollection(); - BasicDBObject filter = new BasicDBObject("_id", projectId); - WriteResult res = projectCollection.remove(filter); - if(res.getLastError().ok()) { - if(res.getN() == 0) { - return Response.noContent().build(); - } - else { - return Response.ok(this.uriInfo.getAbsolutePathBuilder().segment(projectId).build().toString() + " deleted").build(); - } - } - else { - throw new WebApplicationException(Response.status(Status.BAD_REQUEST).entity(res.getError()).build()); - } + this.projectRepository.delete(projectId); + return Response.ok(this.uriInfo.getAbsolutePathBuilder().segment(projectId).build().toString() + " deleted").build(); + } @@ -113,6 +102,7 @@ } + //TODO: uses spring data @GET @Produces(MediaType.APPLICATION_JSON + ";charset=utf-8") public String getProjectList() { @@ -159,6 +149,7 @@ return JSON.serialize(res); } + //TODO: rewrite for recursive object and use spring data private Response createOrUpdateProject(String projectId, String projectContent) { if(null == projectContent || projectContent.isEmpty()) { diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/WEB-INF/jsp/projectPrompt.jsp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/webapp/WEB-INF/jsp/projectPrompt.jsp Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,12 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> + + + + +Project prompt + + + ${message} + + \ No newline at end of file diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/WEB-INF/spring-servlet.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/webapp/WEB-INF/spring-servlet.xml Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/WEB-INF/templates/renkanProjectEdit.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/webapp/WEB-INF/templates/renkanProjectEdit.html Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,106 @@ + + + + + + Test de Rendu RENKAN + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/WEB-INF/templates/renkanProjectRender.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/server/src/main/webapp/WEB-INF/templates/renkanProjectRender.html Tue Dec 25 21:29:11 2012 +0100 @@ -0,0 +1,44 @@ + + + + + + Test de Rendu RENKAN + + + + + + + + + + + + + + + +

+ + diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/WEB-INF/web.xml --- a/server/src/main/webapp/WEB-INF/web.xml Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/webapp/WEB-INF/web.xml Tue Dec 25 21:29:11 2012 +0100 @@ -57,10 +57,23 @@ com.sun.jersey.config.property.packages org.iri_research.renkan.rest + + com.sun.jersey.api.json.POJOMappingFeature + true +

rest Servlet

/rest/*

+ + spring + org.springframework.web.servlet.DispatcherServlet + 1 + + + spring + /p/* + \ No newline at end of file diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/css/style.css --- a/server/src/main/webapp/css/style.css Tue Dec 11 00:01:41 2012 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,130 +0,0 @@ -/* ============================================================================= - HTML5 Boilerplate CSS: h5bp.com/css - ========================================================================== */ - -article, aside, details, figcaption, figure, footer, header, hgroup, nav, section { display: block; } -audio, canvas, video { display: inline-block; *display: inline; *zoom: 1; } -audio:not([controls]) { display: none; } -[hidden] { display: none; } - -html { font-size: 100%; -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; } -html, button, input, select, textarea { font-family: sans-serif; color: #222; } -body { margin: 0; font-size: 1em; line-height: 1.4; } - -::-moz-selection { background: #fe57a1; color: #fff; text-shadow: none; } -::selection { background: #fe57a1; color: #fff; text-shadow: none; } - -a { color: #00e; } -a:visited { color: #551a8b; } -a:hover { color: #06e; } -a:focus { outline: thin dotted; } -a:hover, a:active { outline: 0; } - -abbr[title] { border-bottom: 1px dotted; } -b, strong { font-weight: bold; } -blockquote { margin: 1em 40px; } -dfn { font-style: italic; } -hr { display: block; height: 1px; border: 0; border-top: 1px solid #ccc; margin: 1em 0; padding: 0; } -ins { background: #ff9; color: #000; text-decoration: none; } -mark { background: #ff0; color: #000; font-style: italic; font-weight: bold; } -pre, code, kbd, samp { font-family: monospace, serif; _font-family: 'courier new', monospace; font-size: 1em; } -pre { white-space: pre; white-space: pre-wrap; word-wrap: break-word; } -q { quotes: none; } -q:before, q:after { content: ""; content: none; } -small { font-size: 85%; } - -sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; } -sup { top: -0.5em; } -sub { bottom: -0.25em; } - -ul, ol { margin: 1em 0; padding: 0 0 0 40px; } -dd { margin: 0 0 0 40px; } -nav ul, nav ol { list-style: none; list-style-image: none; margin: 0; padding: 0; } - -img { border: 0; -ms-interpolation-mode: bicubic; vertical-align: middle; } - -svg:not(:root) { overflow: hidden; } - -figure { margin: 0; } - -form { margin: 0; } -fieldset { border: 0; margin: 0; padding: 0; } -label { cursor: pointer; } -legend { border: 0; *margin-left: -7px; padding: 0; white-space: normal; } -button, input, select, textarea { font-size: 100%; margin: 0; vertical-align: baseline; *vertical-align: middle; } -button, input { line-height: normal; } -button, input[type="button"], input[type="reset"], input[type="submit"] { cursor: pointer; -webkit-appearance: button; *overflow: visible; } -button[disabled], input[disabled] { cursor: default; } -input[type="checkbox"], input[type="radio"] { box-sizing: border-box; padding: 0; *width: 13px; *height: 13px; } -input[type="search"] { -webkit-appearance: textfield; -moz-box-sizing: content-box; -webkit-box-sizing: content-box; box-sizing: content-box; } -input[type="search"]::-webkit-search-decoration, input[type="search"]::-webkit-search-cancel-button { -webkit-appearance: none; } -button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; } -textarea { overflow: auto; vertical-align: top; resize: vertical; } -input:valid, textarea:valid { } -input:invalid, textarea:invalid { background-color: #f0dddd; } - -table { border-collapse: collapse; border-spacing: 0; } -td { vertical-align: top; } - -.chromeframe { margin: 0.2em 0; background: #ccc; color: black; padding: 0.2em 0; } - - - -/* ===== Primary Styles ======================================================== - Author: - ========================================================================== */ -.templates { display: none; } - -.project_desc_label { font-weight: bold; } - -#project_display { - background: #9cbc2c; - -moz-border-radius: 5px; - -webkit-border-radius: 5px; - border-radius: 5px; - padding: 20px; - width: 400px; -} - - - -/* ============================================================================= - Media Queries - ========================================================================== */ - -@media only screen and (min-width: 35em) { - /* Style adjustments for viewports that meet the condition */ -} - -/* ============================================================================= - Non-Semantic Helper Classes - ========================================================================== */ - -.ir { display: block; border: 0; text-indent: -999em; overflow: hidden; background-color: transparent; background-repeat: no-repeat; text-align: left; direction: ltr; *line-height: 0; } -.ir br { display: none; } -.hidden { display: none !important; visibility: hidden; } -.visuallyhidden { border: 0; clip: rect(0 0 0 0); height: 1px; margin: -1px; overflow: hidden; padding: 0; position: absolute; width: 1px; } -.visuallyhidden.focusable:active, .visuallyhidden.focusable:focus { clip: auto; height: auto; margin: 0; overflow: visible; position: static; width: auto; } -.invisible { visibility: hidden; } -.clearfix:before, .clearfix:after { content: ""; display: table; } -.clearfix:after { clear: both; } -.clearfix { *zoom: 1; } - -/* ============================================================================= - Print Styles - ========================================================================== */ - -@media print { - * { background: transparent !important; color: black !important; box-shadow:none !important; text-shadow: none !important; filter:none !important; -ms-filter: none !important; } /* Black prints faster: h5bp.com/s */ - a, a:visited { text-decoration: underline; } - a[href]:after { content: " (" attr(href) ")"; } - abbr[title]:after { content: " (" attr(title) ")"; } - .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; } /* Don't show links for images, or javascript/internal links */ - pre, blockquote { border: 1px solid #999; page-break-inside: avoid; } - thead { display: table-header-group; } /* h5bp.com/t */ - tr, img { page-break-inside: avoid; } - img { max-width: 100% !important; } - @page { margin: 0.5cm; } - p, h2, h3 { orphans: 3; widows: 3; } - h2, h3 { page-break-after: avoid; } -} diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/index.html --- a/server/src/main/webapp/index.html Tue Dec 11 00:01:41 2012 +0100 +++ b/server/src/main/webapp/index.html Tue Dec 25 21:29:11 2012 +0100 @@ -1,12 +1,161 @@ - + - - - My Cooperative Web Application - - - - - - + Renkan + + + + + + + + + +

New Renkan

or create/open a Renkan with the name

+ +

+ + diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/js/backbone-relational.js --- a/server/src/main/webapp/js/backbone-relational.js Tue Dec 11 00:01:41 2012 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1687 +0,0 @@ -/** - * Backbone-relational.js 0.6.0 - * (c) 2011 Paul Uithol - * - * Backbone-relational may be freely distributed under the MIT license; see the accompanying LICENSE.txt. - * For details and documentation: https://github.com/PaulUithol/Backbone-relational. - * Depends on Backbone (and thus on Underscore as well): https://github.com/documentcloud/backbone. - */ -( function( undefined ) { - "use strict"; - - /** - * CommonJS shim - **/ - var _, Backbone, exports; - if ( typeof window === 'undefined' ) { - _ = require( 'underscore' ); - Backbone = require( 'backbone' ); - exports = module.exports = Backbone; - } - else { - _ = window._; - Backbone = window.Backbone; - exports = window; - } - - Backbone.Relational = { - showWarnings: true - }; - - /** - * Semaphore mixin; can be used as both binary and counting. - **/ - Backbone.Semaphore = { - _permitsAvailable: null, - _permitsUsed: 0, - - acquire: function() { - if ( this._permitsAvailable && this._permitsUsed >= this._permitsAvailable ) { - throw new Error( 'Max permits acquired' ); - } - else { - this._permitsUsed++; - } - }, - - release: function() { - if ( this._permitsUsed === 0 ) { - throw new Error( 'All permits released' ); - } - else { - this._permitsUsed--; - } - }, - - isLocked: function() { - return this._permitsUsed > 0; - }, - - setAvailablePermits: function( amount ) { - if ( this._permitsUsed > amount ) { - throw new Error( 'Available permits cannot be less than used permits' ); - } - this._permitsAvailable = amount; - } - }; - - /** - * A BlockingQueue that accumulates items while blocked (via 'block'), - * and processes them when unblocked (via 'unblock'). - * Process can also be called manually (via 'process'). - */ - Backbone.BlockingQueue = function() { - this._queue = []; - }; - _.extend( Backbone.BlockingQueue.prototype, Backbone.Semaphore, { - _queue: null, - - add: function( func ) { - if ( this.isBlocked() ) { - this._queue.push( func ); - } - else { - func(); - } - }, - - process: function() { - while ( this._queue && this._queue.length ) { - this._queue.shift()(); - } - }, - - block: function() { - this.acquire(); - }, - - unblock: function() { - this.release(); - if ( !this.isBlocked() ) { - this.process(); - } - }, - - isBlocked: function() { - return this.isLocked(); - } - }); - /** - * Global event queue. Accumulates external events ('add:', 'remove:' and 'update:') - * until the top-level object is fully initialized (see 'Backbone.RelationalModel'). - */ - Backbone.Relational.eventQueue = new Backbone.BlockingQueue(); - - /** - * Backbone.Store keeps track of all created (and destruction of) Backbone.RelationalModel. - * Handles lookup for relations. - */ - Backbone.Store = function() { - this._collections = []; - this._reverseRelations = []; - this._subModels = []; - this._modelScopes = [ exports ]; - }; - _.extend( Backbone.Store.prototype, Backbone.Events, { - addModelScope: function( scope ) { - this._modelScopes.push( scope ); - }, - - /** - * Add a set of subModelTypes to the store, that can be used to resolve the '_superModel' - * for a model later in 'setupSuperModel'. - * - * @param {Backbone.RelationalModel} subModelTypes - * @param {Backbone.RelationalModel} superModelType - */ - addSubModels: function( subModelTypes, superModelType ) { - this._subModels.push({ - 'superModelType': superModelType, - 'subModels': subModelTypes - }); - }, - - /** - * Check if the given modelType is registered as another model's subModel. If so, add it to the super model's - * '_subModels', and set the modelType's '_superModel', '_subModelTypeName', and '_subModelTypeAttribute'. - * - * @param {Backbone.RelationalModel} modelType - */ - setupSuperModel: function( modelType ) { - _.find( this._subModels, function( subModelDef ) { - return _.find( subModelDef.subModels, function( subModelTypeName, typeValue ) { - var subModelType = this.getObjectByName( subModelTypeName ); - - if ( modelType === subModelType ) { - // Set 'modelType' as a child of the found superModel - subModelDef.superModelType._subModels[ typeValue ] = modelType; - - // Set '_superModel', '_subModelTypeValue', and '_subModelTypeAttribute' on 'modelType'. - modelType._superModel = subModelDef.superModelType; - modelType._subModelTypeValue = typeValue; - modelType._subModelTypeAttribute = subModelDef.superModelType.prototype.subModelTypeAttribute; - return true; - } - }, this ); - }, this ); - }, - - /** - * Add a reverse relation. Is added to the 'relations' property on model's prototype, and to - * existing instances of 'model' in the store as well. - * @param {Object} relation - * @param {Backbone.RelationalModel} relation.model - * @param {String} relation.type - * @param {String} relation.key - * @param {String|Object} relation.relatedModel - */ - addReverseRelation: function( relation ) { - var exists = _.any( this._reverseRelations, function( rel ) { - return _.all( relation, function( val, key ) { - return val === rel[ key ]; - }); - }); - - if ( !exists && relation.model && relation.type ) { - this._reverseRelations.push( relation ); - - var addRelation = function( model, relation ) { - if ( !model.prototype.relations ) { - model.prototype.relations = []; - } - model.prototype.relations.push( relation ); - - _.each( model._subModels, function( subModel ) { - addRelation( subModel, relation ); - }, this ); - }; - - addRelation( relation.model, relation ); - - this.retroFitRelation( relation ); - } - }, - - /** - * Add a 'relation' to all existing instances of 'relation.model' in the store - * @param {Object} relation - */ - retroFitRelation: function( relation ) { - var coll = this.getCollection( relation.model ); - coll.each( function( model ) { - if ( !( model instanceof relation.model ) ) { - return; - } - - new relation.type( model, relation ); - }, this); - }, - - /** - * Find the Store's collection for a certain type of model. - * @param {Backbone.RelationalModel} model - * @return {Backbone.Collection} A collection if found (or applicable for 'model'), or null - */ - getCollection: function( model ) { - if ( model instanceof Backbone.RelationalModel ) { - model = model.constructor; - } - - var rootModel = model; - while ( rootModel._superModel ) { - rootModel = rootModel._superModel; - } - - var coll = _.detect( this._collections, function( c ) { - return c.model === rootModel; - }); - - if ( !coll ) { - coll = this._createCollection( rootModel ); - } - - return coll; - }, - - /** - * Find a type on the global object by name. Splits name on dots. - * @param {String} name - * @return {Object} - */ - getObjectByName: function( name ) { - var parts = name.split( '.' ), - type = null; - - _.find( this._modelScopes, function( scope ) { - type = _.reduce( parts, function( memo, val ) { - return memo[ val ]; - }, scope ); - - if ( type && type !== scope ) { - return true; - } - }, this ); - - return type; - }, - - _createCollection: function( type ) { - var coll; - - // If 'type' is an instance, take its constructor - if ( type instanceof Backbone.RelationalModel ) { - type = type.constructor; - } - - // Type should inherit from Backbone.RelationalModel. - if ( type.prototype instanceof Backbone.RelationalModel ) { - coll = new Backbone.Collection(); - coll.model = type; - - this._collections.push( coll ); - } - - return coll; - }, - - /** - * Find the attribute that is to be used as the `id` on a given object - * @param type - * @param {String|Number|Object|Backbone.RelationalModel} item - * @return {String|Number} - */ - resolveIdForItem: function( type, item ) { - var id = _.isString( item ) || _.isNumber( item ) ? item : null; - - if ( id === null ) { - if ( item instanceof Backbone.RelationalModel ) { - id = item.id; - } - else if ( _.isObject( item ) ) { - id = item[ type.prototype.idAttribute ]; - } - } - - // Make all falsy values `null` (except for 0, which could be an id.. see '/issues/179') - if ( !id && id !== 0 ) { - id = null; - } - - return id; - }, - - /** - * - * @param type - * @param {String|Number|Object|Backbone.RelationalModel} item - */ - find: function( type, item ) { - var id = this.resolveIdForItem( type, item ); - var coll = this.getCollection( type ); - - // Because the found object could be of any of the type's superModel - // types, only return it if it's actually of the type asked for. - if ( coll ) { - var obj = coll.get( id ); - - if ( obj instanceof type ) { - return obj; - } - } - - return null; - }, - - /** - * Add a 'model' to it's appropriate collection. Retain the original contents of 'model.collection'. - * @param {Backbone.RelationalModel} model - */ - register: function( model ) { - var coll = this.getCollection( model ); - - if ( coll ) { - if ( coll.get( model ) ) { - throw new Error( "Cannot instantiate more than one Backbone.RelationalModel with the same id per type!" ); - } - - var modelColl = model.collection; - coll.add( model ); - model.bind( 'destroy', this.unregister, this ); - model.collection = modelColl; - } - }, - - /** - * Explicitly update a model's id in it's store collection - * @param {Backbone.RelationalModel} model - */ - update: function( model ) { - var coll = this.getCollection( model ); - coll._onModelEvent( 'change:' + model.idAttribute, model, coll ); - }, - - /** - * Remove a 'model' from the store. - * @param {Backbone.RelationalModel} model - */ - unregister: function( model ) { - model.unbind( 'destroy', this.unregister ); - var coll = this.getCollection( model ); - coll && coll.remove( model ); - } - }); - Backbone.Relational.store = new Backbone.Store(); - - /** - * The main Relation class, from which 'HasOne' and 'HasMany' inherit. Internally, 'relational:' events - * are used to regulate addition and removal of models from relations. - * - * @param {Backbone.RelationalModel} instance - * @param {Object} options - * @param {string} options.key - * @param {Backbone.RelationalModel.constructor} options.relatedModel - * @param {Boolean|String} [options.includeInJSON=true] Serialize the given attribute for related model(s)' in toJSON, or just their ids. - * @param {Boolean} [options.createModels=true] Create objects from the contents of keys if the object is not found in Backbone.store. - * @param {Object} [options.reverseRelation] Specify a bi-directional relation. If provided, Relation will reciprocate - * the relation to the 'relatedModel'. Required and optional properties match 'options', except that it also needs - * {Backbone.Relation|String} type ('HasOne' or 'HasMany'). - */ - Backbone.Relation = function( instance, options ) { - this.instance = instance; - // Make sure 'options' is sane, and fill with defaults from subclasses and this object's prototype - options = _.isObject( options ) ? options : {}; - this.reverseRelation = _.defaults( options.reverseRelation || {}, this.options.reverseRelation ); - this.reverseRelation.type = !_.isString( this.reverseRelation.type ) ? this.reverseRelation.type : - Backbone[ this.reverseRelation.type ] || Backbone.Relational.store.getObjectByName( this.reverseRelation.type ); - this.model = options.model || this.instance.constructor; - this.options = _.defaults( options, this.options, Backbone.Relation.prototype.options ); - - this.key = this.options.key; - this.keySource = this.options.keySource || this.key; - this.keyDestination = this.options.keyDestination || this.keySource || this.key; - - // 'exports' should be the global object where 'relatedModel' can be found on if given as a string. - this.relatedModel = this.options.relatedModel; - if ( _.isString( this.relatedModel ) ) { - this.relatedModel = Backbone.Relational.store.getObjectByName( this.relatedModel ); - } - - if ( !this.checkPreconditions() ) { - return false; - } - - if ( instance ) { - this.keyContents = this.instance.get( this.keySource ); - - // Explicitly clear 'keySource', to prevent a leaky abstraction if 'keySource' differs from 'key'. - if ( this.key !== this.keySource ) { - this.instance.unset( this.keySource, { silent: true } ); - } - - // Add this Relation to instance._relations - this.instance._relations.push( this ); - } - - // Add the reverse relation on 'relatedModel' to the store's reverseRelations - if ( !this.options.isAutoRelation && this.reverseRelation.type && this.reverseRelation.key ) { - Backbone.Relational.store.addReverseRelation( _.defaults( { - isAutoRelation: true, - model: this.relatedModel, - relatedModel: this.model, - reverseRelation: this.options // current relation is the 'reverseRelation' for it's own reverseRelation - }, - this.reverseRelation // Take further properties from this.reverseRelation (type, key, etc.) - ) ); - } - - _.bindAll( this, '_modelRemovedFromCollection', '_relatedModelAdded', '_relatedModelRemoved' ); - - if ( instance ) { - this.initialize(); - - // When a model in the store is destroyed, check if it is 'this.instance'. - Backbone.Relational.store.getCollection( this.instance ) - .bind( 'relational:remove', this._modelRemovedFromCollection ); - - // When 'relatedModel' are created or destroyed, check if it affects this relation. - Backbone.Relational.store.getCollection( this.relatedModel ) - .bind( 'relational:add', this._relatedModelAdded ) - .bind( 'relational:remove', this._relatedModelRemoved ); - } - }; - // Fix inheritance :\ - Backbone.Relation.extend = Backbone.Model.extend; - // Set up all inheritable **Backbone.Relation** properties and methods. - _.extend( Backbone.Relation.prototype, Backbone.Events, Backbone.Semaphore, { - options: { - createModels: true, - includeInJSON: true, - isAutoRelation: false - }, - - instance: null, - key: null, - keyContents: null, - relatedModel: null, - reverseRelation: null, - related: null, - - _relatedModelAdded: function( model, coll, options ) { - // Allow 'model' to set up it's relations, before calling 'tryAddRelated' - // (which can result in a call to 'addRelated' on a relation of 'model') - var dit = this; - model.queue( function() { - dit.tryAddRelated( model, options ); - }); - }, - - _relatedModelRemoved: function( model, coll, options ) { - this.removeRelated( model, options ); - }, - - _modelRemovedFromCollection: function( model ) { - if ( model === this.instance ) { - this.destroy(); - } - }, - - /** - * Check several pre-conditions. - * @return {Boolean} True if pre-conditions are satisfied, false if they're not. - */ - checkPreconditions: function() { - var i = this.instance, - k = this.key, - m = this.model, - rm = this.relatedModel, - warn = Backbone.Relational.showWarnings && typeof console !== 'undefined'; - - if ( !m || !k || !rm ) { - warn && console.warn( 'Relation=%o; no model, key or relatedModel (%o, %o, %o)', this, m, k, rm ); - return false; - } - // Check if the type in 'model' inherits from Backbone.RelationalModel - if ( !( m.prototype instanceof Backbone.RelationalModel ) ) { - warn && console.warn( 'Relation=%o; model does not inherit from Backbone.RelationalModel (%o)', this, i ); - return false; - } - // Check if the type in 'relatedModel' inherits from Backbone.RelationalModel - if ( !( rm.prototype instanceof Backbone.RelationalModel ) ) { - warn && console.warn( 'Relation=%o; relatedModel does not inherit from Backbone.RelationalModel (%o)', this, rm ); - return false; - } - // Check if this is not a HasMany, and the reverse relation is HasMany as well - if ( this instanceof Backbone.HasMany && this.reverseRelation.type === Backbone.HasMany ) { - warn && console.warn( 'Relation=%o; relation is a HasMany, and the reverseRelation is HasMany as well.', this ); - return false; - } - - // Check if we're not attempting to create a duplicate relationship - if ( i && i._relations.length ) { - var exists = _.any( i._relations, function( rel ) { - var hasReverseRelation = this.reverseRelation.key && rel.reverseRelation.key; - return rel.relatedModel === rm && rel.key === k && - ( !hasReverseRelation || this.reverseRelation.key === rel.reverseRelation.key ); - }, this ); - - if ( exists ) { - warn && console.warn( 'Relation=%o between instance=%o.%s and relatedModel=%o.%s already exists', - this, i, k, rm, this.reverseRelation.key ); - return false; - } - } - - return true; - }, - - /** - * Set the related model(s) for this relation - * @param {Backbone.Mode|Backbone.Collection} related - * @param {Object} [options] - */ - setRelated: function( related, options ) { - this.related = related; - - this.instance.acquire(); - this.instance.set( this.key, related, _.defaults( options || {}, { silent: true } ) ); - this.instance.release(); - }, - - /** - * Determine if a relation (on a different RelationalModel) is the reverse - * relation of the current one. - * @param {Backbone.Relation} relation - * @return {Boolean} - */ - _isReverseRelation: function( relation ) { - if ( relation.instance instanceof this.relatedModel && this.reverseRelation.key === relation.key && - this.key === relation.reverseRelation.key ) { - return true; - } - return false; - }, - - /** - * Get the reverse relations (pointing back to 'this.key' on 'this.instance') for the currently related model(s). - * @param {Backbone.RelationalModel} [model] Get the reverse relations for a specific model. - * If not specified, 'this.related' is used. - * @return {Backbone.Relation[]} - */ - getReverseRelations: function( model ) { - var reverseRelations = []; - // Iterate over 'model', 'this.related.models' (if this.related is a Backbone.Collection), or wrap 'this.related' in an array. - var models = !_.isUndefined( model ) ? [ model ] : this.related && ( this.related.models || [ this.related ] ); - _.each( models , function( related ) { - _.each( related.getRelations(), function( relation ) { - if ( this._isReverseRelation( relation ) ) { - reverseRelations.push( relation ); - } - }, this ); - }, this ); - - return reverseRelations; - }, - - /** - * Rename options.silent to options.silentChange, so events propagate properly. - * (for example in HasMany, from 'addRelated'->'handleAddition') - * @param {Object} [options] - * @return {Object} - */ - sanitizeOptions: function( options ) { - options = options ? _.clone( options ) : {}; - if ( options.silent ) { - options.silentChange = true; - delete options.silent; - } - return options; - }, - - /** - * Rename options.silentChange to options.silent, so events are silenced as intended in Backbone's - * original functions. - * @param {Object} [options] - * @return {Object} - */ - unsanitizeOptions: function( options ) { - options = options ? _.clone( options ) : {}; - if ( options.silentChange ) { - options.silent = true; - delete options.silentChange; - } - return options; - }, - - // Cleanup. Get reverse relation, call removeRelated on each. - destroy: function() { - Backbone.Relational.store.getCollection( this.instance ) - .unbind( 'relational:remove', this._modelRemovedFromCollection ); - - Backbone.Relational.store.getCollection( this.relatedModel ) - .unbind( 'relational:add', this._relatedModelAdded ) - .unbind( 'relational:remove', this._relatedModelRemoved ); - - _.each( this.getReverseRelations(), function( relation ) { - relation.removeRelated( this.instance ); - }, this ); - } - }); - - Backbone.HasOne = Backbone.Relation.extend({ - options: { - reverseRelation: { type: 'HasMany' } - }, - - initialize: function() { - _.bindAll( this, 'onChange' ); - - this.instance.bind( 'relational:change:' + this.key, this.onChange ); - - var model = this.findRelated( { silent: true } ); - this.setRelated( model ); - - // Notify new 'related' object of the new relation. - _.each( this.getReverseRelations(), function( relation ) { - relation.addRelated( this.instance ); - }, this ); - }, - - findRelated: function( options ) { - var item = this.keyContents; - var model = null; - - if ( item instanceof this.relatedModel ) { - model = item; - } - else if ( item || item === 0 ) { // since 0 can be a valid `id` as well - model = this.relatedModel.findOrCreate( item, { create: this.options.createModels } ); - } - - return model; - }, - - /** - * If the key is changed, notify old & new reverse relations and initialize the new relation - */ - onChange: function( model, attr, options ) { - // Don't accept recursive calls to onChange (like onChange->findRelated->findOrCreate->initializeRelations->addRelated->onChange) - if ( this.isLocked() ) { - return; - } - this.acquire(); - options = this.sanitizeOptions( options ); - - // 'options._related' is set by 'addRelated'/'removeRelated'. If it is set, the change - // is the result of a call from a relation. If it's not, the change is the result of - // a 'set' call on this.instance. - var changed = _.isUndefined( options._related ); - var oldRelated = changed ? this.related : options._related; - - if ( changed ) { - this.keyContents = attr; - - // Set new 'related' - if ( attr instanceof this.relatedModel ) { - this.related = attr; - } - else if ( attr ) { - var related = this.findRelated( options ); - this.setRelated( related ); - } - else { - this.setRelated( null ); - } - } - - // Notify old 'related' object of the terminated relation - if ( oldRelated && this.related !== oldRelated ) { - _.each( this.getReverseRelations( oldRelated ), function( relation ) { - relation.removeRelated( this.instance, options ); - }, this ); - } - - // Notify new 'related' object of the new relation. Note we do re-apply even if this.related is oldRelated; - // that can be necessary for bi-directional relations if 'this.instance' was created after 'this.related'. - // In that case, 'this.instance' will already know 'this.related', but the reverse might not exist yet. - _.each( this.getReverseRelations(), function( relation ) { - relation.addRelated( this.instance, options ); - }, this); - - // Fire the 'update:' event if 'related' was updated - if ( !options.silentChange && this.related !== oldRelated ) { - var dit = this; - Backbone.Relational.eventQueue.add( function() { - dit.instance.trigger( 'update:' + dit.key, dit.instance, dit.related, options ); - }); - } - this.release(); - }, - - /** - * If a new 'this.relatedModel' appears in the 'store', try to match it to the last set 'keyContents' - */ - tryAddRelated: function( model, options ) { - if ( this.related ) { - return; - } - options = this.sanitizeOptions( options ); - - var item = this.keyContents; - if ( item || item === 0 ) { // since 0 can be a valid `id` as well - var id = Backbone.Relational.store.resolveIdForItem( this.relatedModel, item ); - if ( !_.isNull( id ) && model.id === id ) { - this.addRelated( model, options ); - } - } - }, - - addRelated: function( model, options ) { - if ( model !== this.related ) { - var oldRelated = this.related || null; - this.setRelated( model ); - this.onChange( this.instance, model, { _related: oldRelated } ); - } - }, - - removeRelated: function( model, options ) { - if ( !this.related ) { - return; - } - - if ( model === this.related ) { - var oldRelated = this.related || null; - this.setRelated( null ); - this.onChange( this.instance, model, { _related: oldRelated } ); - } - } - }); - - Backbone.HasMany = Backbone.Relation.extend({ - collectionType: null, - - options: { - reverseRelation: { type: 'HasOne' }, - collectionType: Backbone.Collection, - collectionKey: true, - collectionOptions: {} - }, - - initialize: function() { - _.bindAll( this, 'onChange', 'handleAddition', 'handleRemoval', 'handleReset' ); - this.instance.bind( 'relational:change:' + this.key, this.onChange ); - - // Handle a custom 'collectionType' - this.collectionType = this.options.collectionType; - if ( _.isString( this.collectionType ) ) { - this.collectionType = Backbone.Relational.store.getObjectByName( this.collectionType ); - } - if ( !this.collectionType.prototype instanceof Backbone.Collection ){ - throw new Error( 'collectionType must inherit from Backbone.Collection' ); - } - - // Handle cases where a model/relation is created with a collection passed straight into 'attributes' - if ( this.keyContents instanceof Backbone.Collection ) { - this.setRelated( this._prepareCollection( this.keyContents ) ); - } - else { - this.setRelated( this._prepareCollection() ); - } - - this.findRelated( { silent: true } ); - }, - - _getCollectionOptions: function() { - return _.isFunction( this.options.collectionOptions ) ? - this.options.collectionOptions( this.instance ) : - this.options.collectionOptions; - }, - - /** - * Bind events and setup collectionKeys for a collection that is to be used as the backing store for a HasMany. - * If no 'collection' is supplied, a new collection will be created of the specified 'collectionType' option. - * @param {Backbone.Collection} [collection] - */ - _prepareCollection: function( collection ) { - if ( this.related ) { - this.related - .unbind( 'relational:add', this.handleAddition ) - .unbind( 'relational:remove', this.handleRemoval ) - .unbind( 'relational:reset', this.handleReset ) - } - - if ( !collection || !( collection instanceof Backbone.Collection ) ) { - collection = new this.collectionType( [], this._getCollectionOptions() ); - } - - collection.model = this.relatedModel; - - if ( this.options.collectionKey ) { - var key = this.options.collectionKey === true ? this.options.reverseRelation.key : this.options.collectionKey; - - if ( collection[ key ] && collection[ key ] !== this.instance ) { - if ( Backbone.Relational.showWarnings && typeof console !== 'undefined' ) { - console.warn( 'Relation=%o; collectionKey=%s already exists on collection=%o', this, key, this.options.collectionKey ); - } - } - else if ( key ) { - collection[ key ] = this.instance; - } - } - - collection - .bind( 'relational:add', this.handleAddition ) - .bind( 'relational:remove', this.handleRemoval ) - .bind( 'relational:reset', this.handleReset ); - - return collection; - }, - - findRelated: function( options ) { - if ( this.keyContents ) { - var models = []; - - if ( this.keyContents instanceof Backbone.Collection ) { - models = this.keyContents.models; - } - else { - // Handle cases the an API/user supplies just an Object/id instead of an Array - this.keyContents = _.isArray( this.keyContents ) ? this.keyContents : [ this.keyContents ]; - - // Try to find instances of the appropriate 'relatedModel' in the store - _.each( this.keyContents, function( item ) { - var model = null; - if ( item instanceof this.relatedModel ) { - model = item; - } - else if ( item || item === 0 ) { // since 0 can be a valid `id` as well - model = this.relatedModel.findOrCreate( item, { create: this.options.createModels } ); - } - - if ( model && !this.related.getByCid( model ) && !this.related.get( model ) ) { - models.push( model ); - } - }, this ); - } - - // Add all found 'models' in on go, so 'add' will only be called once (and thus 'sort', etc.) - if ( models.length ) { - options = this.unsanitizeOptions( options ); - this.related.add( models, options ); - } - } - }, - - /** - * If the key is changed, notify old & new reverse relations and initialize the new relation - */ - onChange: function( model, attr, options ) { - options = this.sanitizeOptions( options ); - this.keyContents = attr; - - // Notify old 'related' object of the terminated relation - _.each( this.getReverseRelations(), function( relation ) { - relation.removeRelated( this.instance, options ); - }, this ); - - // Replace 'this.related' by 'attr' if it is a Backbone.Collection - if ( attr instanceof Backbone.Collection ) { - this._prepareCollection( attr ); - this.related = attr; - } - // Otherwise, 'attr' should be an array of related object ids. - // Re-use the current 'this.related' if it is a Backbone.Collection, and remove any current entries. - // Otherwise, create a new collection. - else { - var coll; - - if ( this.related instanceof Backbone.Collection ) { - coll = this.related; - coll.remove( coll.models ); - } - else { - coll = this._prepareCollection(); - } - - this.setRelated( coll ); - this.findRelated( options ); - } - - // Notify new 'related' object of the new relation - _.each( this.getReverseRelations(), function( relation ) { - relation.addRelated( this.instance, options ); - }, this ); - - var dit = this; - Backbone.Relational.eventQueue.add( function() { - !options.silentChange && dit.instance.trigger( 'update:' + dit.key, dit.instance, dit.related, options ); - }); - }, - - tryAddRelated: function( model, options ) { - options = this.sanitizeOptions( options ); - if ( !this.related.getByCid( model ) && !this.related.get( model ) ) { - // Check if this new model was specified in 'this.keyContents' - var item = _.any( this.keyContents, function( item ) { - var id = Backbone.Relational.store.resolveIdForItem( this.relatedModel, item ); - return !_.isNull( id ) && id === model.id; - }, this ); - - if ( item ) { - this.related.add( model, options ); - } - } - }, - - /** - * When a model is added to a 'HasMany', trigger 'add' on 'this.instance' and notify reverse relations. - * (should be 'HasOne', must set 'this.instance' as their related). - */ - handleAddition: function( model, coll, options ) { - //console.debug('handleAddition called; args=%o', arguments); - // Make sure the model is in fact a valid model before continuing. - // (it can be invalid as a result of failing validation in Backbone.Collection._prepareModel) - if ( !( model instanceof Backbone.Model ) ) { - return; - } - - options = this.sanitizeOptions( options ); - - _.each( this.getReverseRelations( model ), function( relation ) { - relation.addRelated( this.instance, options ); - }, this ); - - // Only trigger 'add' once the newly added model is initialized (so, has it's relations set up) - var dit = this; - Backbone.Relational.eventQueue.add( function() { - !options.silentChange && dit.instance.trigger( 'add:' + dit.key, model, dit.related, options ); - }); - }, - - /** - * When a model is removed from a 'HasMany', trigger 'remove' on 'this.instance' and notify reverse relations. - * (should be 'HasOne', which should be nullified) - */ - handleRemoval: function( model, coll, options ) { - //console.debug('handleRemoval called; args=%o', arguments); - if ( !( model instanceof Backbone.Model ) ) { - return; - } - - options = this.sanitizeOptions( options ); - - _.each( this.getReverseRelations( model ), function( relation ) { - relation.removeRelated( this.instance, options ); - }, this ); - - var dit = this; - Backbone.Relational.eventQueue.add( function() { - !options.silentChange && dit.instance.trigger( 'remove:' + dit.key, model, dit.related, options ); - }); - }, - - handleReset: function( coll, options ) { - options = this.sanitizeOptions( options ); - - var dit = this; - Backbone.Relational.eventQueue.add( function() { - !options.silentChange && dit.instance.trigger( 'reset:' + dit.key, dit.related, options ); - }); - }, - - addRelated: function( model, options ) { - var dit = this; - options = this.unsanitizeOptions( options ); - model.queue( function() { // Queued to avoid errors for adding 'model' to the 'this.related' set twice - if ( dit.related && !dit.related.getByCid( model ) && !dit.related.get( model ) ) { - dit.related.add( model, options ); - } - }); - }, - - removeRelated: function( model, options ) { - options = this.unsanitizeOptions( options ); - if ( this.related.getByCid( model ) || this.related.get( model ) ) { - this.related.remove( model, options ); - } - } - }); - - /** - * A type of Backbone.Model that also maintains relations to other models and collections. - * New events when compared to the original: - * - 'add:' (model, related collection, options) - * - 'remove:' (model, related collection, options) - * - 'update:' (model, related model or collection, options) - */ - Backbone.RelationalModel = Backbone.Model.extend({ - relations: null, // Relation descriptions on the prototype - _relations: null, // Relation instances - _isInitialized: false, - _deferProcessing: false, - _queue: null, - - subModelTypeAttribute: 'type', - subModelTypes: null, - - constructor: function( attributes, options ) { - // Nasty hack, for cases like 'model.get( ).add( item )'. - // Defer 'processQueue', so that when 'Relation.createModels' is used we: - // a) Survive 'Backbone.Collection.add'; this takes care we won't error on "can't add model to a set twice" - // (by creating a model from properties, having the model add itself to the collection via one of - // it's relations, then trying to add it to the collection). - // b) Trigger 'HasMany' collection events only after the model is really fully set up. - // Example that triggers both a and b: "p.get('jobs').add( { company: c, person: p } )". - var dit = this; - if ( options && options.collection ) { - this._deferProcessing = true; - - var processQueue = function( model ) { - if ( model === dit ) { - dit._deferProcessing = false; - dit.processQueue(); - options.collection.unbind( 'relational:add', processQueue ); - } - }; - options.collection.bind( 'relational:add', processQueue ); - - // So we do process the queue eventually, regardless of whether this model really gets added to 'options.collection'. - _.defer( function() { - processQueue( dit ); - }); - } - - this._queue = new Backbone.BlockingQueue(); - this._queue.block(); - Backbone.Relational.eventQueue.block(); - - Backbone.Model.apply( this, arguments ); - - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); - }, - - /** - * Override 'trigger' to queue 'change' and 'change:*' events - */ - trigger: function( eventName ) { - if ( eventName.length > 5 && 'change' === eventName.substr( 0, 6 ) ) { - var dit = this, args = arguments; - Backbone.Relational.eventQueue.add( function() { - Backbone.Model.prototype.trigger.apply( dit, args ); - }); - } - else { - Backbone.Model.prototype.trigger.apply( this, arguments ); - } - - return this; - }, - - /** - * Initialize Relations present in this.relations; determine the type (HasOne/HasMany), then creates a new instance. - * Invoked in the first call so 'set' (which is made from the Backbone.Model constructor). - */ - initializeRelations: function() { - this.acquire(); // Setting up relations often also involve calls to 'set', and we only want to enter this function once - this._relations = []; - - _.each( this.relations, function( rel ) { - var type = !_.isString( rel.type ) ? rel.type : Backbone[ rel.type ] || Backbone.Relational.store.getObjectByName( rel.type ); - if ( type && type.prototype instanceof Backbone.Relation ) { - new type( this, rel ); // Also pushes the new Relation into _relations - } - else { - Backbone.Relational.showWarnings && typeof console !== 'undefined' && console.warn( 'Relation=%o; missing or invalid type!', rel ); - } - }, this ); - - this._isInitialized = true; - this.release(); - this.processQueue(); - }, - - /** - * When new values are set, notify this model's relations (also if options.silent is set). - * (Relation.setRelated locks this model before calling 'set' on it to prevent loops) - */ - updateRelations: function( options ) { - if ( this._isInitialized && !this.isLocked() ) { - _.each( this._relations, function( rel ) { - // Update from data in `rel.keySource` if set, or `rel.key` otherwise - var val = this.attributes[ rel.keySource ] || this.attributes[ rel.key ]; - if ( rel.related !== val ) { - this.trigger( 'relational:change:' + rel.key, this, val, options || {} ); - } - }, this ); - } - }, - - /** - * Either add to the queue (if we're not initialized yet), or execute right away. - */ - queue: function( func ) { - this._queue.add( func ); - }, - - /** - * Process _queue - */ - processQueue: function() { - if ( this._isInitialized && !this._deferProcessing && this._queue.isBlocked() ) { - this._queue.unblock(); - } - }, - - /** - * Get a specific relation. - * @param key {string} The relation key to look for. - * @return {Backbone.Relation} An instance of 'Backbone.Relation', if a relation was found for 'key', or null. - */ - getRelation: function( key ) { - return _.detect( this._relations, function( rel ) { - if ( rel.key === key ) { - return true; - } - }, this ); - }, - - /** - * Get all of the created relations. - * @return {Backbone.Relation[]} - */ - getRelations: function() { - return this._relations; - }, - - /** - * Retrieve related objects. - * @param key {string} The relation key to fetch models for. - * @param [options] {Object} Options for 'Backbone.Model.fetch' and 'Backbone.sync'. - * @param [update=false] {boolean} Whether to force a fetch from the server (updating existing models). - * @return {jQuery.when[]} An array of request objects - */ - fetchRelated: function( key, options, update ) { - options || ( options = {} ); - var setUrl, - requests = [], - rel = this.getRelation( key ), - keyContents = rel && rel.keyContents, - toFetch = keyContents && _.select( _.isArray( keyContents ) ? keyContents : [ keyContents ], function( item ) { - var id = Backbone.Relational.store.resolveIdForItem( rel.relatedModel, item ); - return !_.isNull( id ) && ( update || !Backbone.Relational.store.find( rel.relatedModel, id ) ); - }, this ); - - if ( toFetch && toFetch.length ) { - // Create a model for each entry in 'keyContents' that is to be fetched - var models = _.map( toFetch, function( item ) { - var model; - - if ( _.isObject( item ) ) { - model = rel.relatedModel.build( item ); - } - else { - var attrs = {}; - attrs[ rel.relatedModel.prototype.idAttribute ] = item; - model = rel.relatedModel.build( attrs ); - } - - return model; - }, this ); - - // Try if the 'collection' can provide a url to fetch a set of models in one request. - if ( rel.related instanceof Backbone.Collection && _.isFunction( rel.related.url ) ) { - setUrl = rel.related.url( models ); - } - - // An assumption is that when 'Backbone.Collection.url' is a function, it can handle building of set urls. - // To make sure it can, test if the url we got by supplying a list of models to fetch is different from - // the one supplied for the default fetch action (without args to 'url'). - if ( setUrl && setUrl !== rel.related.url() ) { - var opts = _.defaults( - { - error: function() { - var args = arguments; - _.each( models, function( model ) { - model.trigger( 'destroy', model, model.collection, options ); - options.error && options.error.apply( model, args ); - }); - }, - url: setUrl - }, - options, - { add: true } - ); - - requests = [ rel.related.fetch( opts ) ]; - } - else { - requests = _.map( models, function( model ) { - var opts = _.defaults( - { - error: function() { - model.trigger( 'destroy', model, model.collection, options ); - options.error && options.error.apply( model, arguments ); - } - }, - options - ); - return model.fetch( opts ); - }, this ); - } - } - - return requests; - }, - - set: function( key, value, options ) { - Backbone.Relational.eventQueue.block(); - - // Duplicate backbone's behavior to allow separate key/value parameters, instead of a single 'attributes' object - var attributes; - if ( _.isObject( key ) || key == null ) { - attributes = key; - options = value; - } - else { - attributes = {}; - attributes[ key ] = value; - } - - var result = Backbone.Model.prototype.set.apply( this, arguments ); - - // Ideal place to set up relations :) - if ( !this._isInitialized && !this.isLocked() ) { - this.constructor.initializeModelHierarchy(); - - Backbone.Relational.store.register( this ); - - this.initializeRelations(); - } - // Update the 'idAttribute' in Backbone.store if; we don't want it to miss an 'id' update due to {silent:true} - else if ( attributes && this.idAttribute in attributes ) { - Backbone.Relational.store.update( this ); - } - - if ( attributes ) { - this.updateRelations( options ); - } - - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); - - return result; - }, - - unset: function( attribute, options ) { - Backbone.Relational.eventQueue.block(); - - var result = Backbone.Model.prototype.unset.apply( this, arguments ); - this.updateRelations( options ); - - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); - - return result; - }, - - clear: function( options ) { - Backbone.Relational.eventQueue.block(); - - var result = Backbone.Model.prototype.clear.apply( this, arguments ); - this.updateRelations( options ); - - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); - - return result; - }, - - /** - * Override 'change', so the change will only execute after 'set' has finised (relations are updated), - * and 'previousAttributes' will be available when the event is fired. - */ - change: function( options ) { - var dit = this, args = arguments; - Backbone.Relational.eventQueue.add( function() { - Backbone.Model.prototype.change.apply( dit, args ); - }); - }, - - clone: function() { - var attributes = _.clone( this.attributes ); - if ( !_.isUndefined( attributes[ this.idAttribute ] ) ) { - attributes[ this.idAttribute ] = null; - } - - _.each( this.getRelations(), function( rel ) { - delete attributes[ rel.key ]; - }); - - return new this.constructor( attributes ); - }, - - /** - * Convert relations to JSON, omits them when required - */ - toJSON: function() { - // If this Model has already been fully serialized in this branch once, return to avoid loops - if ( this.isLocked() ) { - return this.id; - } - - this.acquire(); - var json = Backbone.Model.prototype.toJSON.call( this ); - - if ( this.constructor._superModel && !( this.constructor._subModelTypeAttribute in json ) ) { - json[ this.constructor._subModelTypeAttribute ] = this.constructor._subModelTypeValue; - } - - _.each( this._relations, function( rel ) { - var value = json[ rel.key ]; - - if ( rel.options.includeInJSON === true) { - if ( value && _.isFunction( value.toJSON ) ) { - json[ rel.keyDestination ] = value.toJSON(); - } - else { - json[ rel.keyDestination ] = null; - } - } - else if ( _.isString( rel.options.includeInJSON ) ) { - if ( value instanceof Backbone.Collection ) { - json[ rel.keyDestination ] = value.pluck( rel.options.includeInJSON ); - } - else if ( value instanceof Backbone.Model ) { - json[ rel.keyDestination ] = value.get( rel.options.includeInJSON ); - } - else { - json[ rel.keyDestination ] = null; - } - } - else if ( _.isArray( rel.options.includeInJSON ) ) { - if ( value instanceof Backbone.Collection ) { - var valueSub = []; - value.each( function( model ) { - var curJson = {}; - _.each( rel.options.includeInJSON, function( key ) { - curJson[ key ] = model.get( key ); - }); - valueSub.push( curJson ); - }); - json[ rel.keyDestination ] = valueSub; - } - else if ( value instanceof Backbone.Model ) { - var valueSub = {}; - _.each( rel.options.includeInJSON, function( key ) { - valueSub[ key ] = value.get( key ); - }); - json[ rel.keyDestination ] = valueSub; - } - else { - json[ rel.keyDestination ] = null; - } - } - else { - delete json[ rel.key ]; - } - - if ( rel.keyDestination !== rel.key ) { - delete json[ rel.key ]; - } - }); - - this.release(); - return json; - } - }, - { - setup: function( superModel ) { - // We don't want to share a relations array with a parent, as this will cause problems with - // reverse relations. - this.prototype.relations = ( this.prototype.relations || [] ).slice( 0 ); - - this._subModels = {}; - this._superModel = null; - - // If this model has 'subModelTypes' itself, remember them in the store - if ( this.prototype.hasOwnProperty( 'subModelTypes' ) ) { - Backbone.Relational.store.addSubModels( this.prototype.subModelTypes, this ); - } - // The 'subModelTypes' property should not be inherited, so reset it. - else { - this.prototype.subModelTypes = null; - } - - // Initialize all reverseRelations that belong to this new model. - _.each( this.prototype.relations, function( rel ) { - if ( !rel.model ) { - rel.model = this; - } - - if ( rel.reverseRelation && rel.model === this ) { - var preInitialize = true; - if ( _.isString( rel.relatedModel ) ) { - /** - * The related model might not be defined for two reasons - * 1. it never gets defined, e.g. a typo - * 2. it is related to itself - * In neither of these cases do we need to pre-initialize reverse relations. - */ - var relatedModel = Backbone.Relational.store.getObjectByName( rel.relatedModel ); - preInitialize = relatedModel && ( relatedModel.prototype instanceof Backbone.RelationalModel ); - } - - var type = !_.isString( rel.type ) ? rel.type : Backbone[ rel.type ] || Backbone.Relational.store.getObjectByName( rel.type ); - if ( preInitialize && type && type.prototype instanceof Backbone.Relation ) { - new type( null, rel ); - } - } - }, this ); - - return this; - }, - - /** - * Create a 'Backbone.Model' instance based on 'attributes'. - * @param {Object} attributes - * @param {Object} [options] - * @return {Backbone.Model} - */ - build: function( attributes, options ) { - var model = this; - - // 'build' is a possible entrypoint; it's possible no model hierarchy has been determined yet. - this.initializeModelHierarchy(); - - // Determine what type of (sub)model should be built if applicable. - // Lookup the proper subModelType in 'this._subModels'. - if ( this._subModels && this.prototype.subModelTypeAttribute in attributes ) { - var subModelTypeAttribute = attributes[ this.prototype.subModelTypeAttribute ]; - var subModelType = this._subModels[ subModelTypeAttribute ]; - if ( subModelType ) { - model = subModelType; - } - } - - return new model( attributes, options ); - }, - - initializeModelHierarchy: function() { - // If we're here for the first time, try to determine if this modelType has a 'superModel'. - if ( _.isUndefined( this._superModel ) || _.isNull( this._superModel ) ) { - Backbone.Relational.store.setupSuperModel( this ); - - // If a superModel has been found, copy relations from the _superModel if they haven't been - // inherited automatically (due to a redefinition of 'relations'). - // Otherwise, make sure we don't get here again for this type by making '_superModel' false so we fail - // the isUndefined/isNull check next time. - if ( this._superModel ) { - // - if ( this._superModel.prototype.relations ) { - var supermodelRelationsExist = _.any( this.prototype.relations, function( rel ) { - return rel.model && rel.model !== this; - }, this ); - - if ( !supermodelRelationsExist ) { - this.prototype.relations = this._superModel.prototype.relations.concat( this.prototype.relations ); - } - } - } - else { - this._superModel = false; - } - } - - // If we came here through 'build' for a model that has 'subModelTypes', and not all of them have been resolved yet, try to resolve each. - if ( this.prototype.subModelTypes && _.keys( this.prototype.subModelTypes ).length !== _.keys( this._subModels ).length ) { - _.each( this.prototype.subModelTypes, function( subModelTypeName ) { - var subModelType = Backbone.Relational.store.getObjectByName( subModelTypeName ); - subModelType && subModelType.initializeModelHierarchy(); - }); - } - }, - - /** - * Find an instance of `this` type in 'Backbone.Relational.store'. - * - If `attributes` is a string or a number, `findOrCreate` will just query the `store` and return a model if found. - * - If `attributes` is an object, the model will be updated with `attributes` if found. - * Otherwise, a new model is created with `attributes` (unless `options.create` is explicitly set to `false`). - * @param {Object|String|Number} attributes Either a model's id, or the attributes used to create or update a model. - * @param {Object} [options] - * @param {Boolean} [options.create=true] - * @return {Backbone.RelationalModel} - */ - findOrCreate: function( attributes, options ) { - // Try to find an instance of 'this' model type in the store - var model = Backbone.Relational.store.find( this, attributes ); - - // If we found an instance, update it with the data in 'item'; if not, create an instance - // (unless 'options.create' is false). - if ( _.isObject( attributes ) ) { - if ( model ) { - model.set( model.parse ? model.parse( attributes ) : attributes, options ); - } - else if ( !options || ( options && options.create !== false ) ) { - model = this.build( attributes, options ); - } - } - - return model; - } - }); - _.extend( Backbone.RelationalModel.prototype, Backbone.Semaphore ); - - /** - * Override Backbone.Collection._prepareModel, so objects will be built using the correct type - * if the collection.model has subModels. - */ - Backbone.Collection.prototype.__prepareModel = Backbone.Collection.prototype._prepareModel; - Backbone.Collection.prototype._prepareModel = function ( model, options ) { - options || (options = {}); - if ( !( model instanceof Backbone.Model ) ) { - var attrs = model; - options.collection = this; - - if ( typeof this.model.findOrCreate !== 'undefined' ) { - model = this.model.findOrCreate( attrs, options ); - } - else { - model = new this.model( attrs, options ); - } - - if ( !model._validate( model.attributes, options ) ) { - model = false; - } - } - else if ( !model.collection ) { - model.collection = this; - } - - return model; - } - - /** - * Override Backbone.Collection.add, so objects fetched from the server multiple times will - * update the existing Model. Also, trigger 'relational:add'. - */ - var add = Backbone.Collection.prototype.__add = Backbone.Collection.prototype.add; - Backbone.Collection.prototype.add = function( models, options ) { - options || (options = {}); - if ( !_.isArray( models ) ) { - models = [ models ]; - } - - var modelsToAdd = []; - - //console.debug( 'calling add on coll=%o; model=%o, options=%o', this, models, options ); - _.each( models, function( model ) { - if ( !( model instanceof Backbone.Model ) ) { - // `_prepareModel` attempts to find `model` in Backbone.store through `findOrCreate`, - // and sets the new properties on it if is found. Otherwise, a new model is instantiated. - model = Backbone.Collection.prototype._prepareModel.call( this, model, options ); - } - - if ( model instanceof Backbone.Model && !this.get( model ) && !this.getByCid( model ) ) { - modelsToAdd.push( model ); - } - }, this ); - - - // Add 'models' in a single batch, so the original add will only be called once (and thus 'sort', etc). - if ( modelsToAdd.length ) { - add.call( this, modelsToAdd, options ); - - _.each( modelsToAdd, function( model ) { - this.trigger( 'relational:add', model, this, options ); - }, this ); - } - - return this; - }; - - /** - * Override 'Backbone.Collection.remove' to trigger 'relational:remove'. - */ - var remove = Backbone.Collection.prototype.__remove = Backbone.Collection.prototype.remove; - Backbone.Collection.prototype.remove = function( models, options ) { - options || (options = {}); - if ( !_.isArray( models ) ) { - models = [ models ]; - } - else { - models = models.slice( 0 ); - } - - //console.debug('calling remove on coll=%o; models=%o, options=%o', this, models, options ); - _.each( models, function( model ) { - model = this.getByCid( model ) || this.get( model ); - - if ( model instanceof Backbone.Model ) { - remove.call( this, model, options ); - this.trigger('relational:remove', model, this, options); - } - }, this ); - - return this; - }; - - /** - * Override 'Backbone.Collection.reset' to trigger 'relational:reset'. - */ - var reset = Backbone.Collection.prototype.__reset = Backbone.Collection.prototype.reset; - Backbone.Collection.prototype.reset = function( models, options ) { - reset.call( this, models, options ); - this.trigger( 'relational:reset', this, options ); - - return this; - }; - - /** - * Override 'Backbone.Collection.sort' to trigger 'relational:reset'. - */ - var sort = Backbone.Collection.prototype.__sort = Backbone.Collection.prototype.sort; - Backbone.Collection.prototype.sort = function( options ) { - sort.call( this, options ); - this.trigger( 'relational:reset', this, options ); - - return this; - }; - - /** - * Override 'Backbone.Collection.trigger' so 'add', 'remove' and 'reset' events are queued until relations - * are ready. - */ - var trigger = Backbone.Collection.prototype.__trigger = Backbone.Collection.prototype.trigger; - Backbone.Collection.prototype.trigger = function( eventName ) { - if ( eventName === 'add' || eventName === 'remove' || eventName === 'reset' ) { - var dit = this, args = arguments; - - if (eventName === 'add') { - args = _.toArray(args); - // the fourth argument in case of a regular add is the option object. - // we need to clone it, as it could be modified while we wait on the eventQueue to be unblocked - if (_.isObject(args[3])) { - args[3] = _.clone(args[3]); - } - } - - Backbone.Relational.eventQueue.add( function() { - trigger.apply( dit, args ); - }); - } - else { - trigger.apply( this, arguments ); - } - - return this; - }; - - // Override .extend() to automatically call .setup() - Backbone.RelationalModel.extend = function( protoProps, classProps ) { - var child = Backbone.Model.extend.apply( this, arguments ); - - child.setup( this ); - - return child; - }; -})(); diff -r 7e132e2a48ca -r 267d67791e05 server/src/main/webapp/js/backbone.js --- a/server/src/main/webapp/js/backbone.js Tue Dec 11 00:01:41 2012 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1431 +0,0 @@ -// Backbone.js 0.9.2 - -// (c) 2010-2012 Jeremy Ashkenas, DocumentCloud Inc. -// Backbone may be freely distributed under the MIT license. -// For all details and documentation: -// http://backbonejs.org - -(function(){ - - // Initial Setup - // ------------- - - // Save a reference to the global object (`window` in the browser, `global` - // on the server). - var root = this; - - // Save the previous value of the `Backbone` variable, so that it can be - // restored later on, if `noConflict` is used. - var previousBackbone = root.Backbone; - - // Create a local reference to slice/splice. - var slice = Array.prototype.slice; - var splice = Array.prototype.splice; - - // The top-level namespace. All public Backbone classes and modules will - // be attached to this. Exported for both CommonJS and the browser. - var Backbone; - if (typeof exports !== 'undefined') { - Backbone = exports; - } else { - Backbone = root.Backbone = {}; - } - - // Current version of the library. Keep in sync with `package.json`. - Backbone.VERSION = '0.9.2'; - - // Require Underscore, if we're on the server, and it's not already present. - var _ = root._; - if (!_ && (typeof require !== 'undefined')) _ = require('underscore'); - - // For Backbone's purposes, jQuery, Zepto, or Ender owns the `$` variable. - var $ = root.jQuery || root.Zepto || root.ender; - - // Set the JavaScript library that will be used for DOM manipulation and - // Ajax calls (a.k.a. the `$` variable). By default Backbone will use: jQuery, - // Zepto, or Ender; but the `setDomLibrary()` method lets you inject an - // alternate JavaScript library (or a mock library for testing your views - // outside of a browser). - Backbone.setDomLibrary = function(lib) { - $ = lib; - }; - - // Runs Backbone.js in *noConflict* mode, returning the `Backbone` variable - // to its previous owner. Returns a reference to this Backbone object. - Backbone.noConflict = function() { - root.Backbone = previousBackbone; - return this; - }; - - // Turn on `emulateHTTP` to support legacy HTTP servers. Setting this option - // will fake `"PUT"` and `"DELETE"` requests via the `_method` parameter and - // set a `X-Http-Method-Override` header. - Backbone.emulateHTTP = false; - - // Turn on `emulateJSON` to support legacy servers that can't deal with direct - // `application/json` requests ... will encode the body as - // `application/x-www-form-urlencoded` instead and will send the model in a - // form param named `model`. - Backbone.emulateJSON = false; - - // Backbone.Events - // ----------------- - - // Regular expression used to split event strings - var eventSplitter = /\s+/; - - // A module that can be mixed in to *any object* in order to provide it with - // custom events. You may bind with `on` or remove with `off` callback functions - // to an event; trigger`-ing an event fires all callbacks in succession. - // - // var object = {}; - // _.extend(object, Backbone.Events); - // object.on('expand', function(){ alert('expanded'); }); - // object.trigger('expand'); - // - var Events = Backbone.Events = { - - // Bind one or more space separated events, `events`, to a `callback` - // function. Passing `"all"` will bind the callback to all events fired. - on: function(events, callback, context) { - - var calls, event, node, tail, list; - if (!callback) return this; - events = events.split(eventSplitter); - calls = this._callbacks || (this._callbacks = {}); - - // Create an immutable callback list, allowing traversal during - // modification. The tail is an empty object that will always be used - // as the next node. - while (event = events.shift()) { - list = calls[event]; - node = list ? list.tail : {}; - node.next = tail = {}; - node.context = context; - node.callback = callback; - calls[event] = {tail: tail, next: list ? list.next : node}; - } - - return this; - }, - - // Remove one or many callbacks. If `context` is null, removes all callbacks - // with that function. If `callback` is null, removes all callbacks for the - // event. If `events` is null, removes all bound callbacks for all events. - off: function(events, callback, context) { - var event, calls, node, tail, cb, ctx; - - // No events, or removing *all* events. - if (!(calls = this._callbacks)) return; - if (!(events || callback || context)) { - delete this._callbacks; - return this; - } - - // Loop through the listed events and contexts, splicing them out of the - // linked list of callbacks if appropriate. - events = events ? events.split(eventSplitter) : _.keys(calls); - while (event = events.shift()) { - node = calls[event]; - delete calls[event]; - if (!node || !(callback || context)) continue; - // Create a new list, omitting the indicated callbacks. - tail = node.tail; - while ((node = node.next) !== tail) { - cb = node.callback; - ctx = node.context; - if ((callback && cb !== callback) || (context && ctx !== context)) { - this.on(event, cb, ctx); - } - } - } - - return this; - }, - - // Trigger one or many events, firing all bound callbacks. Callbacks are - // passed the same arguments as `trigger` is, apart from the event name - // (unless you're listening on `"all"`, which will cause your callback to - // receive the true name of the event as the first argument). - trigger: function(events) { - var event, node, calls, tail, args, all, rest; - if (!(calls = this._callbacks)) return this; - all = calls.all; - events = events.split(eventSplitter); - rest = slice.call(arguments, 1); - - // For each event, walk through the linked list of callbacks twice, - // first to trigger the event, then to trigger any `"all"` callbacks. - while (event = events.shift()) { - if (node = calls[event]) { - tail = node.tail; - while ((node = node.next) !== tail) { - node.callback.apply(node.context || this, rest); - } - } - if (node = all) { - tail = node.tail; - args = [event].concat(rest); - while ((node = node.next) !== tail) { - node.callback.apply(node.context || this, args); - } - } - } - - return this; - } - - }; - - // Aliases for backwards compatibility. - Events.bind = Events.on; - Events.unbind = Events.off; - - // Backbone.Model - // -------------- - - // Create a new model, with defined attributes. A client id (`cid`) - // is automatically generated and assigned for you. - var Model = Backbone.Model = function(attributes, options) { - var defaults; - attributes || (attributes = {}); - if (options && options.parse) attributes = this.parse(attributes); - if (defaults = getValue(this, 'defaults')) { - attributes = _.extend({}, defaults, attributes); - } - if (options && options.collection) this.collection = options.collection; - this.attributes = {}; - this._escapedAttributes = {}; - this.cid = _.uniqueId('c'); - this.changed = {}; - this._silent = {}; - this._pending = {}; - this.set(attributes, {silent: true}); - // Reset change tracking. - this.changed = {}; - this._silent = {}; - this._pending = {}; - this._previousAttributes = _.clone(this.attributes); - this.initialize.apply(this, arguments); - }; - - // Attach all inheritable methods to the Model prototype. - _.extend(Model.prototype, Events, { - - // A hash of attributes whose current and previous value differ. - changed: null, - - // A hash of attributes that have silently changed since the last time - // `change` was called. Will become pending attributes on the next call. - _silent: null, - - // A hash of attributes that have changed since the last `'change'` event - // began. - _pending: null, - - // The default name for the JSON `id` attribute is `"id"`. MongoDB and - // CouchDB users may want to set this to `"_id"`. - idAttribute: 'id', - - // Initialize is an empty function by default. Override it with your own - // initialization logic. - initialize: function(){}, - - // Return a copy of the model's `attributes` object. - toJSON: function(options) { - return _.clone(this.attributes); - }, - - // Get the value of an attribute. - get: function(attr) { - return this.attributes[attr]; - }, - - // Get the HTML-escaped value of an attribute. - escape: function(attr) { - var html; - if (html = this._escapedAttributes[attr]) return html; - var val = this.get(attr); - return this._escapedAttributes[attr] = _.escape(val == null ? '' : '' + val); - }, - - // Returns `true` if the attribute contains a value that is not null - // or undefined. - has: function(attr) { - return this.get(attr) != null; - }, - - // Set a hash of model attributes on the object, firing `"change"` unless - // you choose to silence it. - set: function(key, value, options) { - var attrs, attr, val; - - // Handle both `"key", value` and `{key: value}` -style arguments. - if (_.isObject(key) || key == null) { - attrs = key; - options = value; - } else { - attrs = {}; - attrs[key] = value; - } - - // Extract attributes and options. - options || (options = {}); - if (!attrs) return this; - if (attrs instanceof Model) attrs = attrs.attributes; - if (options.unset) for (attr in attrs) attrs[attr] = void 0; - - // Run validation. - if (!this._validate(attrs, options)) return false; - - // Check for changes of `id`. - if (this.idAttribute in attrs) this.id = attrs[this.idAttribute]; - - var changes = options.changes = {}; - var now = this.attributes; - var escaped = this._escapedAttributes; - var prev = this._previousAttributes || {}; - - // For each `set` attribute... - for (attr in attrs) { - val = attrs[attr]; - - // If the new and current value differ, record the change. - if (!_.isEqual(now[attr], val) || (options.unset && _.has(now, attr))) { - delete escaped[attr]; - (options.silent ? this._silent : changes)[attr] = true; - } - - // Update or delete the current value. - options.unset ? delete now[attr] : now[attr] = val; - - // If the new and previous value differ, record the change. If not, - // then remove changes for this attribute. - if (!_.isEqual(prev[attr], val) || (_.has(now, attr) != _.has(prev, attr))) { - this.changed[attr] = val; - if (!options.silent) this._pending[attr] = true; - } else { - delete this.changed[attr]; - delete this._pending[attr]; - } - } - - // Fire the `"change"` events. - if (!options.silent) this.change(options); - return this; - }, - - // Remove an attribute from the model, firing `"change"` unless you choose - // to silence it. `unset` is a noop if the attribute doesn't exist. - unset: function(attr, options) { - (options || (options = {})).unset = true; - return this.set(attr, null, options); - }, - - // Clear all attributes on the model, firing `"change"` unless you choose - // to silence it. - clear: function(options) { - (options || (options = {})).unset = true; - return this.set(_.clone(this.attributes), options); - }, - - // Fetch the model from the server. If the server's representation of the - // model differs from its current attributes, they will be overriden, - // triggering a `"change"` event. - fetch: function(options) { - options = options ? _.clone(options) : {}; - var model = this; - var success = options.success; - options.success = function(resp, status, xhr) { - if (!model.set(model.parse(resp, xhr), options)) return false; - if (success) success(model, resp); - }; - options.error = Backbone.wrapError(options.error, model, options); - return (this.sync || Backbone.sync).call(this, 'read', this, options); - }, - - // Set a hash of model attributes, and sync the model to the server. - // If the server returns an attributes hash that differs, the model's - // state will be `set` again. - save: function(key, value, options) { - var attrs, current; - - // Handle both `("key", value)` and `({key: value})` -style calls. - if (_.isObject(key) || key == null) { - attrs = key; - options = value; - } else { - attrs = {}; - attrs[key] = value; - } - options = options ? _.clone(options) : {}; - - // If we're "wait"-ing to set changed attributes, validate early. - if (options.wait) { - if (!this._validate(attrs, options)) return false; - current = _.clone(this.attributes); - } - - // Regular saves `set` attributes before persisting to the server. - var silentOptions = _.extend({}, options, {silent: true}); - if (attrs && !this.set(attrs, options.wait ? silentOptions : options)) { - return false; - } - - // After a successful server-side save, the client is (optionally) - // updated with the server-side state. - var model = this; - var success = options.success; - options.success = function(resp, status, xhr) { - var serverAttrs = model.parse(resp, xhr); - if (options.wait) { - delete options.wait; - serverAttrs = _.extend(attrs || {}, serverAttrs); - } - if (!model.set(serverAttrs, options)) return false; - if (success) { - success(model, resp); - } else { - model.trigger('sync', model, resp, options); - } - }; - - // Finish configuring and sending the Ajax request. - options.error = Backbone.wrapError(options.error, model, options); - var method = this.isNew() ? 'create' : 'update'; - var xhr = (this.sync || Backbone.sync).call(this, method, this, options); - if (options.wait) this.set(current, silentOptions); - return xhr; - }, - - // Destroy this model on the server if it was already persisted. - // Optimistically removes the model from its collection, if it has one. - // If `wait: true` is passed, waits for the server to respond before removal. - destroy: function(options) { - options = options ? _.clone(options) : {}; - var model = this; - var success = options.success; - - var triggerDestroy = function() { - model.trigger('destroy', model, model.collection, options); - }; - - if (this.isNew()) { - triggerDestroy(); - return false; - } - - options.success = function(resp) { - if (options.wait) triggerDestroy(); - if (success) { - success(model, resp); - } else { - model.trigger('sync', model, resp, options); - } - }; - - options.error = Backbone.wrapError(options.error, model, options); - var xhr = (this.sync || Backbone.sync).call(this, 'delete', this, options); - if (!options.wait) triggerDestroy(); - return xhr; - }, - - // Default URL for the model's representation on the server -- if you're - // using Backbone's restful methods, override this to change the endpoint - // that will be called. - url: function() { - var base = getValue(this, 'urlRoot') || getValue(this.collection, 'url') || urlError(); - if (this.isNew()) return base; - return base + (base.charAt(base.length - 1) == '/' ? '' : '/') + encodeURIComponent(this.id); - }, - - // **parse** converts a response into the hash of attributes to be `set` on - // the model. The default implementation is just to pass the response along. - parse: function(resp, xhr) { - return resp; - }, - - // Create a new model with identical attributes to this one. - clone: function() { - return new this.constructor(this.attributes); - }, - - // A model is new if it has never been saved to the server, and lacks an id. - isNew: function() { - return this.id == null; - }, - - // Call this method to manually fire a `"change"` event for this model and - // a `"change:attribute"` event for each changed attribute. - // Calling this will cause all objects observing the model to update. - change: function(options) { - options || (options = {}); - var changing = this._changing; - this._changing = true; - - // Silent changes become pending changes. - for (var attr in this._silent) this._pending[attr] = true; - - // Silent changes are triggered. - var changes = _.extend({}, options.changes, this._silent); - this._silent = {}; - for (var attr in changes) { - this.trigger('change:' + attr, this, this.get(attr), options); - } - if (changing) return this; - - // Continue firing `"change"` events while there are pending changes. - while (!_.isEmpty(this._pending)) { - this._pending = {}; - this.trigger('change', this, options); - // Pending and silent changes still remain. - for (var attr in this.changed) { - if (this._pending[attr] || this._silent[attr]) continue; - delete this.changed[attr]; - } - this._previousAttributes = _.clone(this.attributes); - } - - this._changing = false; - return this; - }, - - // Determine if the model has changed since the last `"change"` event. - // If you specify an attribute name, determine if that attribute has changed. - hasChanged: function(attr) { - if (!arguments.length) return !_.isEmpty(this.changed); - return _.has(this.changed, attr); - }, - - // Return an object containing all the attributes that have changed, or - // false if there are no changed attributes. Useful for determining what - // parts of a view need to be updated and/or what attributes need to be - // persisted to the server. Unset attributes will be set to undefined. - // You can also pass an attributes object to diff against the model, - // determining if there *would be* a change. - changedAttributes: function(diff) { - if (!diff) return this.hasChanged() ? _.clone(this.changed) : false; - var val, changed = false, old = this._previousAttributes; - for (var attr in diff) { - if (_.isEqual(old[attr], (val = diff[attr]))) continue; - (changed || (changed = {}))[attr] = val; - } - return changed; - }, - - // Get the previous value of an attribute, recorded at the time the last - // `"change"` event was fired. - previous: function(attr) { - if (!arguments.length || !this._previousAttributes) return null; - return this._previousAttributes[attr]; - }, - - // Get all of the attributes of the model at the time of the previous - // `"change"` event. - previousAttributes: function() { - return _.clone(this._previousAttributes); - }, - - // Check if the model is currently in a valid state. It's only possible to - // get into an *invalid* state if you're using silent changes. - isValid: function() { - return !this.validate(this.attributes); - }, - - // Run validation against the next complete set of model attributes, - // returning `true` if all is well. If a specific `error` callback has - // been passed, call that instead of firing the general `"error"` event. - _validate: function(attrs, options) { - if (options.silent || !this.validate) return true; - attrs = _.extend({}, this.attributes, attrs); - var error = this.validate(attrs, options); - if (!error) return true; - if (options && options.error) { - options.error(this, error, options); - } else { - this.trigger('error', this, error, options); - } - return false; - } - - }); - - // Backbone.Collection - // ------------------- - - // Provides a standard collection class for our sets of models, ordered - // or unordered. If a `comparator` is specified, the Collection will maintain - // its models in sort order, as they're added and removed. - var Collection = Backbone.Collection = function(models, options) { - options || (options = {}); - if (options.model) this.model = options.model; - if (options.comparator) this.comparator = options.comparator; - this._reset(); - this.initialize.apply(this, arguments); - if (models) this.reset(models, {silent: true, parse: options.parse}); - }; - - // Define the Collection's inheritable methods. - _.extend(Collection.prototype, Events, { - - // The default model for a collection is just a **Backbone.Model**. - // This should be overridden in most cases. - model: Model, - - // Initialize is an empty function by default. Override it with your own - // initialization logic. - initialize: function(){}, - - // The JSON representation of a Collection is an array of the - // models' attributes. - toJSON: function(options) { - return this.map(function(model){ return model.toJSON(options); }); - }, - - // Add a model, or list of models to the set. Pass **silent** to avoid - // firing the `add` event for every new model. - add: function(models, options) { - var i, index, length, model, cid, id, cids = {}, ids = {}, dups = []; - options || (options = {}); - models = _.isArray(models) ? models.slice() : [models]; - - // Begin by turning bare objects into model references, and preventing - // invalid models or duplicate models from being added. - for (i = 0, length = models.length; i < length; i++) { - if (!(model = models[i] = this._prepareModel(models[i], options))) { - throw new Error("Can't add an invalid model to a collection"); - } - cid = model.cid; - id = model.id; - if (cids[cid] || this._byCid[cid] || ((id != null) && (ids[id] || this._byId[id]))) { - dups.push(i); - continue; - } - cids[cid] = ids[id] = model; - } - - // Remove duplicates. - i = dups.length; - while (i--) { - models.splice(dups[i], 1); - } - - // Listen to added models' events, and index models for lookup by - // `id` and by `cid`. - for (i = 0, length = models.length; i < length; i++) { - (model = models[i]).on('all', this._onModelEvent, this); - this._byCid[model.cid] = model; - if (model.id != null) this._byId[model.id] = model; - } - - // Insert models into the collection, re-sorting if needed, and triggering - // `add` events unless silenced. - this.length += length; - index = options.at != null ? options.at : this.models.length; - splice.apply(this.models, [index, 0].concat(models)); - if (this.comparator) this.sort({silent: true}); - if (options.silent) return this; - for (i = 0, length = this.models.length; i < length; i++) { - if (!cids[(model = this.models[i]).cid]) continue; - options.index = i; - model.trigger('add', model, this, options); - } - return this; - }, - - // Remove a model, or a list of models from the set. Pass silent to avoid - // firing the `remove` event for every model removed. - remove: function(models, options) { - var i, l, index, model; - options || (options = {}); - models = _.isArray(models) ? models.slice() : [models]; - for (i = 0, l = models.length; i < l; i++) { - model = this.getByCid(models[i]) || this.get(models[i]); - if (!model) continue; - delete this._byId[model.id]; - delete this._byCid[model.cid]; - index = this.indexOf(model); - this.models.splice(index, 1); - this.length--; - if (!options.silent) { - options.index = index; - model.trigger('remove', model, this, options); - } - this._removeReference(model); - } - return this; - }, - - // Add a model to the end of the collection. - push: function(model, options) { - model = this._prepareModel(model, options); - this.add(model, options); - return model; - }, - - // Remove a model from the end of the collection. - pop: function(options) { - var model = this.at(this.length - 1); - this.remove(model, options); - return model; - }, - - // Add a model to the beginning of the collection. - unshift: function(model, options) { - model = this._prepareModel(model, options); - this.add(model, _.extend({at: 0}, options)); - return model; - }, - - // Remove a model from the beginning of the collection. - shift: function(options) { - var model = this.at(0); - this.remove(model, options); - return model; - }, - - // Get a model from the set by id. - get: function(id) { - if (id == null) return void 0; - return this._byId[id.id != null ? id.id : id]; - }, - - // Get a model from the set by client id. - getByCid: function(cid) { - return cid && this._byCid[cid.cid || cid]; - }, - - // Get the model at the given index. - at: function(index) { - return this.models[index]; - }, - - // Return models with matching attributes. Useful for simple cases of `filter`. - where: function(attrs) { - if (_.isEmpty(attrs)) return []; - return this.filter(function(model) { - for (var key in attrs) { - if (attrs[key] !== model.get(key)) return false; - } - return true; - }); - }, - - // Force the collection to re-sort itself. You don't need to call this under - // normal circumstances, as the set will maintain sort order as each item - // is added. - sort: function(options) { - options || (options = {}); - if (!this.comparator) throw new Error('Cannot sort a set without a comparator'); - var boundComparator = _.bind(this.comparator, this); - if (this.comparator.length == 1) { - this.models = this.sortBy(boundComparator); - } else { - this.models.sort(boundComparator); - } - if (!options.silent) this.trigger('reset', this, options); - return this; - }, - - // Pluck an attribute from each model in the collection. - pluck: function(attr) { - return _.map(this.models, function(model){ return model.get(attr); }); - }, - - // When you have more items than you want to add or remove individually, - // you can reset the entire set with a new list of models, without firing - // any `add` or `remove` events. Fires `reset` when finished. - reset: function(models, options) { - models || (models = []); - options || (options = {}); - for (var i = 0, l = this.models.length; i < l; i++) { - this._removeReference(this.models[i]); - } - this._reset(); - this.add(models, _.extend({silent: true}, options)); - if (!options.silent) this.trigger('reset', this, options); - return this; - }, - - // Fetch the default set of models for this collection, resetting the - // collection when they arrive. If `add: true` is passed, appends the - // models to the collection instead of resetting. - fetch: function(options) { - options = options ? _.clone(options) : {}; - if (options.parse === undefined) options.parse = true; - var collection = this; - var success = options.success; - options.success = function(resp, status, xhr) { - collection[options.add ? 'add' : 'reset'](collection.parse(resp, xhr), options); - if (success) success(collection, resp); - }; - options.error = Backbone.wrapError(options.error, collection, options); - return (this.sync || Backbone.sync).call(this, 'read', this, options); - }, - - // Create a new instance of a model in this collection. Add the model to the - // collection immediately, unless `wait: true` is passed, in which case we - // wait for the server to agree. - create: function(model, options) { - var coll = this; - options = options ? _.clone(options) : {}; - model = this._prepareModel(model, options); - if (!model) return false; - if (!options.wait) coll.add(model, options); - var success = options.success; - options.success = function(nextModel, resp, xhr) { - if (options.wait) coll.add(nextModel, options); - if (success) { - success(nextModel, resp); - } else { - nextModel.trigger('sync', model, resp, options); - } - }; - model.save(null, options); - return model; - }, - - // **parse** converts a response into a list of models to be added to the - // collection. The default implementation is just to pass it through. - parse: function(resp, xhr) { - return resp; - }, - - // Proxy to _'s chain. Can't be proxied the same way the rest of the - // underscore methods are proxied because it relies on the underscore - // constructor. - chain: function () { - return _(this.models).chain(); - }, - - // Reset all internal state. Called when the collection is reset. - _reset: function(options) { - this.length = 0; - this.models = []; - this._byId = {}; - this._byCid = {}; - }, - - // Prepare a model or hash of attributes to be added to this collection. - _prepareModel: function(model, options) { - options || (options = {}); - if (!(model instanceof Model)) { - var attrs = model; - options.collection = this; - model = new this.model(attrs, options); - if (!model._validate(model.attributes, options)) model = false; - } else if (!model.collection) { - model.collection = this; - } - return model; - }, - - // Internal method to remove a model's ties to a collection. - _removeReference: function(model) { - if (this == model.collection) { - delete model.collection; - } - model.off('all', this._onModelEvent, this); - }, - - // Internal method called every time a model in the set fires an event. - // Sets need to update their indexes when models change ids. All other - // events simply proxy through. "add" and "remove" events that originate - // in other collections are ignored. - _onModelEvent: function(event, model, collection, options) { - if ((event == 'add' || event == 'remove') && collection != this) return; - if (event == 'destroy') { - this.remove(model, options); - } - if (model && event === 'change:' + model.idAttribute) { - delete this._byId[model.previous(model.idAttribute)]; - this._byId[model.id] = model; - } - this.trigger.apply(this, arguments); - } - - }); - - // Underscore methods that we want to implement on the Collection. - var methods = ['forEach', 'each', 'map', 'reduce', 'reduceRight', 'find', - 'detect', 'filter', 'select', 'reject', 'every', 'all', 'some', 'any', - 'include', 'contains', 'invoke', 'max', 'min', 'sortBy', 'sortedIndex', - 'toArray', 'size', 'first', 'initial', 'rest', 'last', 'without', 'indexOf', - 'shuffle', 'lastIndexOf', 'isEmpty', 'groupBy']; - - // Mix in each Underscore method as a proxy to `Collection#models`. - _.each(methods, function(method) { - Collection.prototype[method] = function() { - return _[method].apply(_, [this.models].concat(_.toArray(arguments))); - }; - }); - - // Backbone.Router - // ------------------- - - // Routers map faux-URLs to actions, and fire events when routes are - // matched. Creating a new one sets its `routes` hash, if not set statically. - var Router = Backbone.Router = function(options) { - options || (options = {}); - if (options.routes) this.routes = options.routes; - this._bindRoutes(); - this.initialize.apply(this, arguments); - }; - - // Cached regular expressions for matching named param parts and splatted - // parts of route strings. - var namedParam = /:\w+/g; - var splatParam = /\*\w+/g; - var escapeRegExp = /[-[\]{}()+?.,\\^$|#\s]/g; - - // Set up all inheritable **Backbone.Router** properties and methods. - _.extend(Router.prototype, Events, { - - // Initialize is an empty function by default. Override it with your own - // initialization logic. - initialize: function(){}, - - // Manually bind a single named route to a callback. For example: - // - // this.route('search/:query/p:num', 'search', function(query, num) { - // ... - // }); - // - route: function(route, name, callback) { - Backbone.history || (Backbone.history = new History); - if (!_.isRegExp(route)) route = this._routeToRegExp(route); - if (!callback) callback = this[name]; - Backbone.history.route(route, _.bind(function(fragment) { - var args = this._extractParameters(route, fragment); - callback && callback.apply(this, args); - this.trigger.apply(this, ['route:' + name].concat(args)); - Backbone.history.trigger('route', this, name, args); - }, this)); - return this; - }, - - // Simple proxy to `Backbone.history` to save a fragment into the history. - navigate: function(fragment, options) { - Backbone.history.navigate(fragment, options); - }, - - // Bind all defined routes to `Backbone.history`. We have to reverse the - // order of the routes here to support behavior where the most general - // routes can be defined at the bottom of the route map. - _bindRoutes: function() { - if (!this.routes) return; - var routes = []; - for (var route in this.routes) { - routes.unshift([route, this.routes[route]]); - } - for (var i = 0, l = routes.length; i < l; i++) { - this.route(routes[i][0], routes[i][1], this[routes[i][1]]); - } - }, - - // Convert a route string into a regular expression, suitable for matching - // against the current location hash. - _routeToRegExp: function(route) { - route = route.replace(escapeRegExp, '\\$&') - .replace(namedParam, '([^\/]+)') - .replace(splatParam, '(.*?)'); - return new RegExp('^' + route + '$'); - }, - - // Given a route, and a URL fragment that it matches, return the array of - // extracted parameters. - _extractParameters: function(route, fragment) { - return route.exec(fragment).slice(1); - } - - }); - - // Backbone.History - // ---------------- - - // Handles cross-browser history management, based on URL fragments. If the - // browser does not support `onhashchange`, falls back to polling. - var History = Backbone.History = function() { - this.handlers = []; - _.bindAll(this, 'checkUrl'); - }; - - // Cached regex for cleaning leading hashes and slashes . - var routeStripper = /^[#\/]/; - - // Cached regex for detecting MSIE. - var isExplorer = /msie [\w.]+/; - - // Has the history handling already been started? - History.started = false; - - // Set up all inheritable **Backbone.History** properties and methods. - _.extend(History.prototype, Events, { - - // The default interval to poll for hash changes, if necessary, is - // twenty times a second. - interval: 50, - - // Gets the true hash value. Cannot use location.hash directly due to bug - // in Firefox where location.hash will always be decoded. - getHash: function(windowOverride) { - var loc = windowOverride ? windowOverride.location : window.location; - var match = loc.href.match(/#(.*)$/); - return match ? match[1] : ''; - }, - - // Get the cross-browser normalized URL fragment, either from the URL, - // the hash, or the override. - getFragment: function(fragment, forcePushState) { - if (fragment == null) { - if (this._hasPushState || forcePushState) { - fragment = window.location.pathname; - var search = window.location.search; - if (search) fragment += search; - } else { - fragment = this.getHash(); - } - } - if (!fragment.indexOf(this.options.root)) fragment = fragment.substr(this.options.root.length); - return fragment.replace(routeStripper, ''); - }, - - // Start the hash change handling, returning `true` if the current URL matches - // an existing route, and `false` otherwise. - start: function(options) { - if (History.started) throw new Error("Backbone.history has already been started"); - History.started = true; - - // Figure out the initial configuration. Do we need an iframe? - // Is pushState desired ... is it available? - this.options = _.extend({}, {root: '/'}, this.options, options); - this._wantsHashChange = this.options.hashChange !== false; - this._wantsPushState = !!this.options.pushState; - this._hasPushState = !!(this.options.pushState && window.history && window.history.pushState); - var fragment = this.getFragment(); - var docMode = document.documentMode; - var oldIE = (isExplorer.exec(navigator.userAgent.toLowerCase()) && (!docMode || docMode <= 7)); - - if (oldIE) { - this.iframe = $('