app/addons/documents/routes-documents.js

// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.

define([
  "app",
  "api",

  // Modules
  'addons/documents/shared-routes',
  'addons/documents/views',
  'addons/documents/changes/components.react',
  'addons/documents/changes/actions',
  'addons/databases/base',
  'addons/documents/resources',
  'addons/fauxton/components',
  'addons/documents/pagination/stores',
  'addons/documents/index-results/actions',
  'addons/documents/index-results/index-results.components.react',
  'addons/documents/pagination/pagination.react',
  'addons/documents/header/header.react',
  'addons/documents/header/header.actions',
  'addons/documents/sidebar/actions',
  'addons/documents/designdocinfo/actions',
  'addons/documents/designdocinfo/components.react'
],

function (app, FauxtonAPI, BaseRoute, Documents, Changes, ChangesActions, Databases, Resources, Components,
  PaginationStores, IndexResultsActions, IndexResultsComponents, ReactPagination, ReactHeader, ReactActions,
  SidebarActions, DesignDocInfoActions, DesignDocInfoComponents) {

    var DocumentsRouteObject = BaseRoute.extend({
      layout: "with_tabs_sidebar",
      routes: {
        "database/:database/_all_docs(:extra)": {
          route: "allDocs",
          roles: ["fx_loggedIn"]
        },
        "database/:database/_design/:ddoc/_info": {
          route: "designDocMetadata",
          roles: ['fx_loggedIn']
        },
        'database/:database/_changes': 'changes'

      },

      events: {
        "route:reloadDesignDocs": "reloadDesignDocs"
      },

      initialize: function (route, masterLayout, options) {
        this.initViews(options[0]);
        this.listenToLookaheadTray();
      },

      establish: function () {
        return [
          this.designDocs.fetch({reset: true}),
          this.allDatabases.fetchOnce()
        ];
      },

      initViews: function (dbName) {
        this.databaseName = dbName;
        this.database = new Databases.Model({id: this.databaseName});
        this.allDatabases = this.getAllDatabases();

        this.createDesignDocsCollection();

        this.rightHeader = this.setView("#right-header", new Documents.Views.RightAllDocsHeader({
          database: this.database
        }));

        this.addLeftHeader();
        this.addSidebar();
      },

      designDocMetadata: function (database, ddoc) {
        this.removeComponent('#footer');
        this.removeComponent('#react-headerbar');
        this.removeComponent('#dashboard-upper-content');

        var designDocInfo = new Resources.DdocInfo({ _id: "_design/" + ddoc }, { database: this.database });
        DesignDocInfoActions.fetchDesignDocInfo({
          ddocName: ddoc,
          designDocInfo: designDocInfo
        });
        this.setComponent("#dashboard-lower-content", DesignDocInfoComponents.DesignDocInfo);

        SidebarActions.setSelectedTab(app.utils.removeSpecialCharacters(ddoc) + "_metadata");

        this.leftheader.updateCrumbs(this.getCrumbs(this.database));
        this.rightHeader.hideQueryOptions();

        this.apiUrl = [designDocInfo.url('apiurl'), designDocInfo.documentation()];
      },

      /*
      * docParams are the options collection uses to fetch from the server
      * urlParams are what are shown in the url and to the user
      * They are not the same when paginating
      */
      allDocs: function (databaseName, options) {
        var params = this.createParams(options),
            urlParams = params.urlParams,
            docParams = params.docParams,
            collection;

        this.setComponent('#react-headerbar', ReactHeader.BulkDocumentHeaderController);
        this.setComponent('#footer', ReactPagination.Footer);

        this.leftheader.updateCrumbs(this.getCrumbs(this.database));

        // includes_docs = true if you are visiting the _replicator/_users databases
        if ( ['_replicator', '_users'].indexOf(databaseName) > -1) {
          docParams.include_docs = true;
          urlParams = params.docParams;
          var updatedURL = FauxtonAPI.urls('allDocs', 'app', databaseName, '?' + $.param(urlParams));
          FauxtonAPI.navigate(updatedURL, {trigger: false, replace: true});
        }

        this.database.buildAllDocs(docParams);
        collection = this.database.allDocs;

        var tab = 'all-docs';
        if (docParams.startkey && docParams.startkey.indexOf("_design") > -1) {
          tab = 'design-docs';
        }

        SidebarActions.setSelectedTab(tab);

        this.removeComponent('#dashboard-upper-content');

        if (!docParams) {
          docParams = {};
        }

        IndexResultsActions.newResultsList({
          collection: collection,
          textEmptyIndex: 'No Documents Found',
          bulkCollection: Documents.BulkDeleteDocCollection
        });

        this.database.allDocs.paging.pageSize = PaginationStores.indexPaginationStore.getPerPage();

        this.setComponent('#dashboard-lower-content', IndexResultsComponents.List);

        // this used to be a function that returned the object, but be warned: it caused a closure with a reference to
        // the initial this.database object which can change
        this.apiUrl = [this.database.allDocs.urlRef("apiurl", urlParams), this.database.allDocs.documentation()];

        // update the rightHeader with the latest & greatest info
        this.rightHeader.resetQueryOptions({ queryParams: urlParams });
        this.rightHeader.showQueryOptions();
      },

      //TODO: REMOVE
      reloadDesignDocs: function (event) {
        if (event && event.selectedTab) {
          SidebarActions.setSelectedTab(event.selectedTab);
        }
      },

      changes: function () {
        ChangesActions.initChanges({
          databaseName: this.database.id
        });
        this.setComponent('#dashboard-upper-content', Changes.ChangesHeaderController);
        this.setComponent("#dashboard-lower-content", Changes.ChangesController);

        this.removeComponent('#footer');
        this.removeComponent('#react-headerbar');

        this.viewEditor && this.viewEditor.remove();

        SidebarActions.setSelectedTab('changes');
        this.leftheader.updateCrumbs(this.getCrumbs(this.database));
        this.rightHeader.hideQueryOptions();

        this.apiUrl = function () {
          return [FauxtonAPI.urls('changes', 'apiurl', this.database.id, ''), this.database.documentation()];
        };
      },

      cleanup: function () {
        // we're no longer interested in listening to the lookahead tray event on this route object
        this.stopListening(FauxtonAPI.Events, 'lookaheadTray:update', this.onSelectDatabase);
        FauxtonAPI.RouteObject.prototype.cleanup.apply(this);
      }

    });

    return DocumentsRouteObject;
  });