redash/rd_ui/app/scripts/controllers/query_view.js

(function() {
  'use strict';

  function QueryViewCtrl($scope, Events, $route, $location, notifications, growl, $modal, Query, DataSource) {
    var DEFAULT_TAB = 'table';

    var getQueryResult = function(maxAge) {
      if (maxAge === undefined) {
        maxAge = $location.search()['maxAge'];
      }

      if (maxAge === undefined) {
        maxAge = -1;
      }

      $scope.showLog = false;
      $scope.queryResult = $scope.query.getQueryResult(maxAge);
    };

    var getDataSourceId = function() {
      // Try to get the query's data source id
      var dataSourceId = $scope.query.data_source_id;

      // If there is no source yet, then parse what we have in localStorage
      //   e.g. `null` -> `NaN`, malformed data -> `NaN`, "1" -> 1
      if (dataSourceId === undefined) {
        dataSourceId = parseInt(localStorage.lastSelectedDataSourceId, 10);
      }

      // If we had an invalid value in localStorage (e.g. nothing, deleted source), then use the first data source
      var isValidDataSourceId = !isNaN(dataSourceId) && _.some($scope.dataSources, function(ds) {
        return ds.id == dataSourceId;
      });

      if (!isValidDataSourceId) {
        dataSourceId = $scope.dataSources[0].id;
      }

      // Return our data source id
      return dataSourceId;
    }

    var updateDataSources = function(dataSources) {
      // Filter out data sources the user can't query (or used by current query):
      $scope.dataSources = _.filter(dataSources, function(dataSource) {
        return !dataSource.view_only || dataSource.id === $scope.query.data_source_id;
      });

      if ($scope.dataSources.length == 0) {
        $scope.noDataSources = true;
        return;
      }

      if ($scope.query.isNew()) {
        $scope.query.data_source_id = getDataSourceId();
      }

      $scope.dataSource = _.find(dataSources, function(ds) { return ds.id == $scope.query.data_source_id; });

      //$scope.canExecuteQuery = $scope.canExecuteQuery && _.some(dataSources, function(ds) { return !ds.view_only });
      $scope.canCreateQuery = _.any(dataSources, function(ds) { return !ds.view_only });

      updateSchema();
    }


    $scope.dataSource = {};
    $scope.query = $route.current.locals.query;

    var updateSchema = function() {
      $scope.hasSchema = false;
      $scope.editorSize = "col-md-12";
      DataSource.getSchema({id: $scope.query.data_source_id}, function(data) {
        if (data && data.length > 0) {
          $scope.schema = data;
          _.each(data, function(table) {
            table.collapsed = true;
          });

          $scope.editorSize = "col-md-9";
          $scope.hasSchema = true;
        } else {
          $scope.hasSchema = false;
          $scope.editorSize = "col-md-12";
        }
      });
    }

    Events.record(currentUser, 'view', 'query', $scope.query.id);
    if ($scope.query.hasResult() || $scope.query.paramsRequired()) {
      getQueryResult();
    }
    $scope.queryExecuting = false;

    $scope.isQueryOwner = (currentUser.id === $scope.query.user.id) || currentUser.hasPermission('admin');
    $scope.canViewSource = currentUser.hasPermission('view_source');

    $scope.canExecuteQuery = function() {
      return currentUser.hasPermission('execute_query') && !$scope.dataSource.view_only;
    }

    $scope.canScheduleQuery = currentUser.hasPermission('schedule_query');

    if ($route.current.locals.dataSources) {
      $scope.dataSources = $route.current.locals.dataSources;
      updateDataSources($route.current.locals.dataSources);
    } else {
      $scope.dataSources = DataSource.query(updateDataSources);
    }

    // in view mode, latest dataset is always visible
    // source mode changes this behavior
    $scope.showDataset = true;
    $scope.showLog = false;

    $scope.lockButton = function(lock) {
      $scope.queryExecuting = lock;
    };

    $scope.showApiKey = function() {
      alert("API Key for this query:\n" + $scope.query.api_key);
    };

    $scope.saveQuery = function(options, data) {
      if (data) {
        data.id = $scope.query.id;
      } else {
        data = _.pick($scope.query, ["schedule", "query", "id", "description", "name", "data_source_id", "options"]);
        if ($scope.query.isNew()) {
          data['latest_query_data_id'] = $scope.query.latest_query_data_id;
        }
      }

      options = _.extend({}, {
        successMessage: 'Query saved',
        errorMessage: 'Query could not be saved'
      }, options);

      return Query.save(data, function() {
        growl.addSuccessMessage(options.successMessage);
      }, function(httpResponse) {
        growl.addErrorMessage(options.errorMessage);
      }).$promise;
    }

    $scope.saveDescription = function() {
      Events.record(currentUser, 'edit_description', 'query', $scope.query.id);
      $scope.saveQuery(undefined, {'description': $scope.query.description});
    };

    $scope.saveName = function() {
      Events.record(currentUser, 'edit_name', 'query', $scope.query.id);
      $scope.saveQuery(undefined, {'name': $scope.query.name});
    };

    $scope.executeQuery = function() {
      if (!$scope.canExecuteQuery()) {
        return;
      }

      if (!$scope.query.query) {
        return;
      }

      getQueryResult(0);
      $scope.lockButton(true);
      $scope.cancelling = false;
      Events.record(currentUser, 'execute', 'query', $scope.query.id);

      notifications.getPermissions();
    };

    $scope.cancelExecution = function() {
      $scope.cancelling = true;
      $scope.queryResult.cancelExecution();
      Events.record(currentUser, 'cancel_execute', 'query', $scope.query.id);
    };

    $scope.archiveQuery = function(options, data) {
      if (data) {
        data.id = $scope.query.id;
      } else {
        data = $scope.query;
      }

      $scope.isDirty = false;

      options = _.extend({}, {
        successMessage: 'Query archived',
        errorMessage: 'Query could not be archived'
      }, options);

      return Query.delete({id: data.id}, function() {
        $scope.query.is_archived = true;
        $scope.query.schedule = null;
        growl.addSuccessMessage(options.successMessage);
          // This feels dirty.
          $('#archive-confirmation-modal').modal('hide');
        }, function(httpResponse) {
          growl.addErrorMessage(options.errorMessage);
        }).$promise;
    }

    $scope.updateDataSource = function() {
      Events.record(currentUser, 'update_data_source', 'query', $scope.query.id);
      localStorage.lastSelectedDataSourceId = $scope.query.data_source_id;

      $scope.query.latest_query_data = null;
      $scope.query.latest_query_data_id = null;

      if ($scope.query.id) {
        Query.save({
          'id': $scope.query.id,
          'data_source_id': $scope.query.data_source_id,
          'latest_query_data_id': null
        });
      }

      updateSchema();
      $scope.dataSource = _.find($scope.dataSources, function(ds) { return ds.id == $scope.query.data_source_id; });
      $scope.executeQuery();
    };

    $scope.setVisualizationTab = function (visualization) {
      $scope.selectedTab = visualization.id;
      $location.hash(visualization.id);
    };

    $scope.$watch('query.name', function() {
      $scope.$parent.pageTitle = $scope.query.name;
    });

    $scope.$watch('queryResult && queryResult.getData()', function(data, oldData) {
      if (!data) {
        return;
      }

      $scope.filters = $scope.queryResult.getFilters();
    });

    $scope.$watch("queryResult && queryResult.getStatus()", function(status) {
      if (!status) {
        return;
      }

      if (status == 'done') {
        $scope.query.latest_query_data_id = $scope.queryResult.getId();
        $scope.query.queryResult = $scope.queryResult;

        notifications.showNotification("Re:dash", $scope.query.name + " updated.");
      } else if (status == 'failed') {
        notifications.showNotification("Re:dash", $scope.query.name + " failed to run: " + $scope.queryResult.getError());
      }

      if (status === 'done' || status === 'failed') {
        $scope.lockButton(false);
      }

      if ($scope.queryResult.getLog() != null) {
          $scope.showLog = true;
      }
    });

    $scope.openVisualizationEditor = function(visualization) {
      function openModal() {
        $modal.open({
          templateUrl: '/views/directives/visualization_editor.html',
          windowClass:'modal-xl',
          scope: $scope,
          controller: ['$scope', '$modalInstance', function($scope, $modalInstance) {
            $scope.modalInstance = $modalInstance;
            $scope.visualization = visualization;
            $scope.close = function() {
              $modalInstance.close();
            }
          }]
        });
      }

      if ($scope.query.isNew()) {
        $scope.saveQuery().then(function(query) {
          // Because we have a path change, we need to "signal" the next page to open the visualization editor.
          $location.path(query.getSourceLink()).hash('add');
        });
      } else {
        openModal();
      }
    };

    if ($location.hash() === 'add') {
      $location.hash(null);
      $scope.openVisualizationEditor();
    }

    $scope.openScheduleForm = function() {
      if (!$scope.isQueryOwner || !$scope.canScheduleQuery) {
        return;
      };

      $modal.open({
        templateUrl: '/views/schedule_form.html',
        size: 'sm',
        scope: $scope,
        controller: ['$scope', '$modalInstance', function($scope, $modalInstance) {
          $scope.close = function() {
            $modalInstance.close();
          }
          if ($scope.query.hasDailySchedule()) {
            $scope.refreshType = 'daily';
          } else {
            $scope.refreshType = 'periodic';
          }
        }]
      });
    };

    $scope.showEmbedDialog = function(query, visualization) {
      $modal.open({
        templateUrl: '/views/dialogs/embed_code.html',
        controller: ['$scope', '$modalInstance', function($scope, $modalInstance) {
          $scope.close = function() {
            $modalInstance.close();
          }
          $scope.embedUrl = basePath + 'embed/query/' + query.id + '/visualization/' + visualization.id + '?api_key=' + query.api_key;
        }]
      })
    }

    $scope.$watch(function() {
      return $location.hash()
    }, function(hash) {
      if (hash == 'pivot') {
        Events.record(currentUser, 'pivot', 'query', $scope.query && $scope.query.id);
      }
      $scope.selectedTab = hash || DEFAULT_TAB;
    });
  };

  angular.module('redash.controllers')
    .controller('QueryViewCtrl',
      ['$scope', 'Events', '$route', '$location', 'notifications', 'growl', '$modal', 'Query', 'DataSource', QueryViewCtrl]);
})();