Issue 395 - Filter hits statistics backend

sitescripts/filterhits/common.py

+# coding: utf-8
+
+# This file is part of the Adblock Plus web scripts,
+# Copyright (C) 2006-2015 Eyeo GmbH
+#
+# Adblock Plus is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+
+from errno import EEXIST
+import json, tempfile, time, os
+
+def show_error(message, start_response, status="400 Processing Error"):
+  start_response(status, [("Content-Type", "text/plain; charset=utf-8")])
+  return [message.encode("utf-8")]
+
+def log_filterhits(data, basepath, query_string):

[Wladimir Palant, 2015/03/26 22:56:50]

This isn't a common function, it is only being used by the submit handler and
should live there.

[kzar, 2015/03/27 11:59:57]

Done.

+  """
+  This logs the provided filterhits data as JSON to a file named after
+  the current timestamp in a directory named after the current date.
+  """
+  now = time.gmtime()
+
+  dir_name = time.strftime("%Y-%m-%d", now)
+  path = os.path.join(basepath, dir_name)
+  try:
+    os.makedirs(path)
+  except OSError as e:
+    if e.errno != EEXIST:
+      raise
+
+  with tempfile.NamedTemporaryFile(
+    prefix = str(int(time.mktime(now))) + "-",
+    suffix = ".log",
+    dir = path,
+    delete = False
+  ) as f:
+    f.write("[%s] \"%s\" %s\n" % (time.strftime('%d/%b/%Y:%H:%M:%S', now),
+                                  query_string, json.dumps(data)))

[Wladimir Palant, 2015/03/26 22:56:50]

Nit: you can use |print >>f, ...| - then you won't need to specify the trailing
newline explicitly.

[kzar, 2015/03/27 11:59:57]

Well apparently that's "unpythonic" I don't mind either way, but are you sure?
http://stackoverflow.com/questions/8598228/f-write-vs-print-f

[Sebastian Noack, 2015/03/27 13:12:19]

I don't agree. I agree though that >> syntax is kinda weird. That is why the
print statement was replaced with a function in Python 3. However, the way
Wladimir suggested is the way to do it in Python 2.

Note that |file.write("foo")| isn't completely the same as |print >>file,
"foo"|.  Amongs others the print statement (or function in Python 3), considers
the terminal encoding when processing unicode objects and automatically picks
the correct newline sequence depending of the OS.

[kzar, 2015/03/27 15:10:50]

Done.

+    return f.name