openproject/app/assets/javascripts/angular/helpers/url-params-helper.js

//-- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2014 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
//++

angular.module('openproject.helpers')

.service('UrlParamsHelper', ['I18n', function(I18n) {
  var UrlParamsHelper = {
    // copied more or less from angular buildUrl
    buildQueryString: function(params) {
      if (!params) return;

      var parts = [];
      angular.forEach(params, function(value, key) {
        if (!value) return;
        if (!Array.isArray(value)) value = [value];

        angular.forEach(value, function(v) {
          if (v !== null && typeof v === 'object') {
            v = toJson(v);
          }
          parts.push(encodeURIComponent(key) + '=' +
                     encodeURIComponent(v));
        });
      });

      return parts.join('&');
    },

    buildQueryExportOptions: function(query){
      // Note: This is all rather hard-codey
      // The alternative would be to pass back export URLs from the server with the meta data but given that columns
      // can be added/removed without making a further work packages index call the meta data wouldn't be up to date.
      // Therefor I think it makes sense to build up the URL from the javascript query object and let the server build
      // up the exact query from the params.
      var relativeUrl = "/work_packages";
      if (query.project_id){
        relativeUrl = "/projects/" + query.project_id + relativeUrl;
      }

      return query.exportFormats.map(function(format){
        var url = relativeUrl + "." + format.format + "?" + "set_filter=1&";
        if(format.flags){
          angular.forEach(format.flags, function(flag){
            url = url + flag + "=" + "true";
          });
        }
        url = url + query.getQueryString();

        return {
          label: I18n.t('js.' + format.label_locale),
          format: format.format,
          url: url
        }
      })
    }
  };

  return UrlParamsHelper;
}]);