feature #370, automatic purge on history

admin/include/functions_history.inc.php

@@ -390,6 +390,96 @@ SELECT *
   }
 }
 
+/**
+ * Smart purge on history table. Keep some lines, purge only summarized lines
+ *
+ * @since 2.9
+ */
+function history_autopurge()
+{
+  global $conf, $logger;
+
+  if (0 == $conf['history_autopurge_keep_lines'])
+  {
+    return;
+  }
+
+  // we want to purge only if there are too many lines and if the lines are summarized
+
+  $query = '
+SELECT
+    COUNT(*)
+  FROM '.HISTORY_TABLE.'
+;';
+  list($count) = pwg_db_fetch_row(pwg_query($query));
+
+  if ($count <= $conf['history_autopurge_keep_lines'])
+  {
+    return; // no need to purge for now
+  }
+
+  // 1) find the last summarized history line
+  $query = '
+SELECT
+    *
+  FROM '.HISTORY_SUMMARY_TABLE.'
+  WHERE history_id_to IS NOT NULL
+  ORDER BY history_id_to DESC
+  LIMIT 1
+;';
+  $summary_lines = query2array($query);
+  if (count($summary_lines) == 0)
+  {
+    return; // lines not summarized, no purge
+  }
+
+  $history_id_last_summarized = $summary_lines[0]['history_id_to'];
+
+  // 2) find the latest history line (and substract the number of lines to keep)
+  $query = '
+SELECT
+    id
+  FROM '.HISTORY_TABLE.'
+  ORDER BY id DESC
+  LIMIT 1
+;';
+  $history_lines = query2array($query);
+  if (count($history_lines) == 0)
+  {
+    return;
+  }
+
+  $history_id_latest = $history_lines[0]['id'];
+
+  // 3) find the oldest history line (and add the number of lines to delete)
+  $query = '
+SELECT
+    id
+  FROM '.HISTORY_TABLE.'
+  ORDER BY id ASC
+  LIMIT 1
+;';
+  $history_lines = query2array($query);
+  $history_id_oldest = $history_lines[0]['id'];
+
+  $search_min = array(
+    $history_id_last_summarized,
+    $history_id_latest - $conf['history_autopurge_keep_lines'],
+    $history_id_oldest + $conf['history_autopurge_blocksize'],
+    );
+  
+  $history_id_delete_before = min($search_min);
+
+  $logger->debug(__FUNCTION__.', '.join('/', $search_min));
+
+  $query = '
+DELETE
+  FROM '.HISTORY_TABLE.'
+  WHERE id < '.$history_id_delete_before.'
+;';
+  pwg_query($query);
+}
+
 add_event_handler('get_history', 'get_history');
 trigger_notify('functions_history_included');
 

include/config_default.inc.php

@@ -553,6 +553,16 @@ $conf['guest_access'] = true;
 // nb_logs_page :  how many logs to display on a page
 $conf['nb_logs_page'] = 300;
 
+// Every X new line in history, perform an automatic purge. The more often,
+// the fewer lines to delete. 0 to disable.
+$conf['history_autopurge_every'] = 1021;
+
+// How many lines to keep in history on autopurge? 0 to disable.
+$conf['history_autopurge_keep_lines'] = 1000000;
+
+// On history autopurge, how many lines should to deleted, maximum?
+$conf['history_autopurge_blocksize'] = 50000;
+
 // +-----------------------------------------------------------------------+
 // |                                 urls                                  |
 // +-----------------------------------------------------------------------+

include/functions.inc.php

@@ -502,6 +502,12 @@ INSERT INTO '.HISTORY_TABLE.'
     history_summarize(50000);
   }
 
+  if ($conf['history_autopurge_every'] > 0 and $history_id % $conf['history_autopurge_every'] == 0)
+  {
+    include_once(PHPWG_ROOT_PATH.'admin/include/functions_history.inc.php');
+    history_autopurge();
+  }
+
   return true;
 }