chook 1.0.1.b1 → 1.1.5b1

data/lib/chook/server/public/css/chook.css

@@ -0,0 +1,133 @@
+@charset "UTF-8";
+
+/* ******* General Styling ******* */
+
+.monospaced {
+  font-family: "Lucida Console", Monaco, monospace;
+}
+
+
+/* ******* Title Header Area ******* */
+
+.chook_title {
+  font-weight: bold;
+  font-size: 2.5em;
+  }
+
+#header_version {
+  font-size: 0.5em;
+}
+
+#definition {
+  line-height: 1.6;
+}
+
+#serverstats {
+  vertical-align: bottom;
+}
+
+.def_pronunciation {
+  font-style: italic;
+  font-size: 1.2em;
+}
+
+.def_part_of_speech {
+  font-weight: bold;
+}
+
+.def_dialect {
+  font-style: italic;
+}
+
+.def_definition {
+  font-size: 1.2em;
+}
+
+#login_incorrect {
+  color: red;
+}
+
+/* ******* Section Label Areas ******* */
+
+.section_label {
+  padding-bottom: 5px;
+}
+
+/* ******* Live Log Section ******* */
+
+#hide_log_btn {
+  display: none;
+}
+
+#logbox_div {
+  display: none;
+}
+
+#logbox_btns {
+  padding-bottom: 5px;
+}
+
+#logbox {
+  width: 100%;
+}
+
+/* ******* Handlers Section ******* */
+
+#hide_handlers_btn {
+  display: none;
+}
+
+#handlers_div {
+  display: none;
+}
+
+#handlers_table {
+  width: 100%;
+  border: 1px solid black;
+  border-collapse: collapse;
+  margin-top: 5px;
+  padding-bottom: 5px;
+}
+
+#handlers_table_header_row {
+  text-align: left;
+  border: 1px solid black;
+  border-collapse: collapse;
+  background-color: LightGrey;
+  padding-top: 4px;
+  padding-left: 3px;
+}
+
+.handlers_table_cell {
+  text-align: left;
+  border: 1px solid black;
+  border-collapse: collapse;
+  padding-top: 4px;
+  padding-left: 3px;
+}
+
+#handler_viewer_div {
+  display: none;
+  padding-top: 15px;
+}
+
+#handler_viewer {
+  width: 95%;
+  border: 3px solid black;
+  padding-top: 5px;
+}
+
+/* ******* Handlers Section ******* */
+
+#hide_config_btn {
+  display: none;
+}
+
+#config_div {
+  display: none;
+}
+
+#config_viewer_div {
+  margin-top: 5px;
+  padding-bottom: 5px;
+}

data/lib/chook/server/public/js/chook.js

@@ -0,0 +1,126 @@
+// log out of basic auth by sending an incorrect name /pw
+// may not work on all browsers
+// see second comment at
+// https://stackoverflow.com/questions/233507/how-to-log-out-user-from-web-site-using-basic-authentication#492926
+
+function logout() {
+  //var logged_out_page = window.location.protocol + '//xxxx:xxxx@' + window.location.host + '/login';
+
+  var xhttp = new XMLHttpRequest();
+
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4) {
+      window.location = "/login";
+    }
+  };
+
+  xhttp.open("GET", "/LOG_OUT:no_such_pw@logout", true);
+  xhttp.setRequestHeader("Authorization", "Basic " + btoa("LOG_OUT:no_such_pw"));
+  xhttp.send();
+}
+
+// show the logbox
+function view_log() {
+  document.getElementById("pause_log").checked = false
+  document.getElementById("logbox_div").style.display = 'block';
+  document.getElementById("view_log_btn").style.display = 'none';
+  document.getElementById("hide_log_btn").style.display = 'inline';
+  start_log_stream();
+  update_logbox();
+}
+
+// hide the logbox
+function hide_log() {
+  document.getElementById("logbox_div").style.display = 'none';
+  document.getElementById("view_log_btn").style.display = 'inline';
+  document.getElementById("hide_log_btn").style.display = 'none';
+  document.getElementById("pause_log").checked = true;
+}
+
+// clear the log stream
+function clear_log(){
+  document.getElementById("logbox").value = '';
+  log_source = '';
+}
+
+// change the log level
+function change_log_level() {
+  var new_level = document.getElementById("log_level_select").value
+  var url = "/set_log_level/" + new_level
+  var xhttp = new XMLHttpRequest();
+  xhttp.open("PUT", url, true);
+  xhttp.send();
+}
+
+// reload the handlers
+function reload_handlers() {
+  var url = '/reload_handlers';
+  var xhttp = new XMLHttpRequest();
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      now = new Date().toLocaleString();
+      document.getElementById("reloaded_notification").innerHTML = 'Reloaded at ' + now;
+    } else {
+      document.getElementById("reloaded_notification").innerHTML = 'Reload Failed.';
+    }
+  };
+  xhttp.open("GET", url, true);
+  xhttp.send();
+}
+
+// show the handler area
+function view_handlers() {
+  document.getElementById("handlers_div").style.display = 'block';
+  document.getElementById("view_handlers_btn").style.display = 'none';
+  document.getElementById("hide_handlers_btn").style.display = 'inline';
+}
+
+// hide the handler area
+function hide_handlers() {
+  document.getElementById("handlers_div").style.display = 'none';
+  document.getElementById("view_handlers_btn").style.display = 'inline';
+  document.getElementById("hide_handlers_btn").style.display = 'none';
+}
+
+// hide the handler editor
+function hide_handler_viewer() {
+  document.getElementById("handler_viewer_div").style.display = 'none';
+}
+
+// show the handler editor with the selected handler code
+// handler = the basename of the hander fle.
+function view_handler_code(handler_path, type) {
+  fetch_handler_code(handler_path) ;
+  document.getElementById("currently_viewing_filename").innerHTML = 'Viewing handler file: ' + handler_path + ' (' + type + ')';
+  document.getElementById("handler_viewer_div").style.display = 'block';
+}
+
+// get the code for an existing handler into the editor
+function fetch_handler_code(handler) {
+  var viewer = document.getElementById("handler_viewer");
+  var url = '/handler_code?filepath=' + encodeURIComponent(handler)
+  var xhttp = new XMLHttpRequest();
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      viewer.value = xhttp.responseText;
+    } else {
+      viewer.value = 'ERROR: File Not Found';
+    }
+  };
+  xhttp.open("GET", url, true);
+  xhttp.send();
+}
+
+// show the config area
+function view_config() {
+  document.getElementById("config_div").style.display = 'block';
+  document.getElementById("view_config_btn").style.display = 'none';
+  document.getElementById("hide_config_btn").style.display = 'inline';
+}
+
+// hide the config area
+function hide_config() {
+  document.getElementById("config_div").style.display = 'none';
+  document.getElementById("view_config_btn").style.display = 'inline';
+  document.getElementById("hide_config_btn").style.display = 'none';
+}

data/lib/chook/server/public/js/logstream.js

@@ -0,0 +1,101 @@
+
+// Vars
+//////////////////////////////////
+
+// the url that will provide the stream
+var log_stream_url = '/subscribe_to_log_stream';
+
+// the EventSource that will get events from the url
+var log_source
+
+// the log box on the info page
+var logbox
+
+// the checkbox to pause updating the log box
+var pause_ckbx
+
+// data from the log gets added to this string
+// but its only written to the log box if we
+// aren't paused.
+var log_data
+
+var new_log_level_regex = /Log level changed, now: (.*)$/;
+
+// update the text in the log box unless the
+// pause checkbox is checked
+function update_logbox() {
+  if (pause_ckbx.checked) { return; }
+  logbox.value = log_data;
+  logbox.scrollTop = logbox.scrollHeight;
+}
+
+// start the stream
+function start_log_stream() {
+  // always update the log level
+  get_current_log_level();
+  // return if already started
+  if (typeof(log_source) != "undefined")  { return; }
+
+  logbox = document.getElementById("logbox");
+  pause_ckbx = document.getElementById("pause_log");
+
+  log_data = logbox.value;
+  log_source = new EventSource(log_stream_url);
+
+  // add incoming lines of data from the server
+  // to the in-memory cache
+  log_source.onmessage = function (event) {
+    var msg = event.data;
+    log_data = log_data + msg + "\n";
+    update_logbox();
+    var match = new_log_level_regex.exec(msg);
+    if (match) { update_log_level_selector(match[1]); }
+  };
+
+  // close the streams when client pages are closed.
+  // The server will see that the streams are closed
+  // and will remove the registrations as needed.
+  window.onbeforeunload = function() {
+     log_source.close();
+     return null;
+  }
+}
+
+// update the selector with the current log level from the server
+function get_current_log_level() {
+  var url = '/current_log_level';
+  var xhttp = new XMLHttpRequest();
+
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      update_log_level_selector(xhttp.responseText);
+    }
+  };
+
+  xhttp.open("GET", url, true);
+  xhttp.send();
+}
+
+function update_log_level_selector(new_level) {
+  var new_idx;
+  switch(new_level) {
+    case 'fatal':
+      new_idx = 0;
+      break;
+    case 'error':
+      new_idx = 1;
+      break;
+    case 'warn':
+      new_idx = 2;
+      break;
+    case 'info':
+      new_idx = 3;
+      break;
+    case 'debug':
+      new_idx = 4;
+      break;
+    default:
+      new_idx = null;
+   }
+  document.getElementById("log_level_select").selectedIndex = new_idx;
+}

data/lib/chook/server/routes.rb

@@ -23,5 +23,33 @@
 ###
 ###
 
+module Chook
+
+  # the server
+  class Server < Sinatra::Base
+
+    HANDLE_EVENT_ROUTE = '/handle_webhook_event'.freeze
+
+  #   before do
+  #     break if request.path_info == Chook::Server::HANDLE_EVENT_ROUTE
+  # #    break if request.path_info == '/' && session[:authed_admin]
+  # #    redirect '/' unless session[:authed_admin]
+  #   end
+
+    # log errors in production (in dev, they go to stdout and the browser)
+    error do
+      logger.error "ERROR: #{env['sinatra.error'].message}"
+      env['sinatra.error'].backtrace.each { |l| logger.error "..#{l}" }
+      500
+    end
+
+  end # server
+
+end # Chook
+
 require 'chook/server/routes/home'
 require 'chook/server/routes/handle_webhook_event'
+require 'chook/server/routes/handle_by_name'
+require 'chook/server/routes/handlers'
+require 'chook/server/routes/login_logout'
+require 'chook/server/routes/log'

data/lib/chook/server/routes/handle_by_name.rb

@@ -0,0 +1,65 @@
+### Copyright 2017 Pixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+module Chook
+
+  # see server.rb
+  class Server < Sinatra::Base
+
+    post '/handler/:handler_name' do
+      # enforce http basic auth if needed
+      protect_via_basic_auth!
+
+      # rewind to ensure read-pointer is at the start
+      request.body.rewind #
+      raw_json = request.body.read
+
+      event = Chook::HandledEvent.parse_event raw_json
+
+      if event.nil?
+        logger.error "Empty JSON from #{request.ip}"
+        result = 400
+      else
+
+        event.logger.debug "START From #{request.ip}, WebHook '#{event.webhook_name}' (id: #{event.webhook_id})"
+        event.logger.debug "Thread id: #{Thread.current.object_id}; JSON: #{raw_json}"
+
+        result = event.handle_by_name params[:handler_name]
+
+        event.logger.debug "END #{result}"
+      end
+
+      # this route shouldn't have a session expiration
+      # And when it does, the date format is wrong, and the
+      # JAMFSoftwareServerLog complains about it for every
+      # webhook sent.
+      env['rack.session.options'].delete :expire_after
+
+      result
+    end # post
+
+  end # class
+
+end # module