0db1b3807a4b1fcb6b9283bcaa32b52adc8ef41e
galt
  Wed Jun 27 17:05:14 2012 -0700
improving botDelay to give us control to allow our own robots to run unbottlenecked if desired via hg.conf setting bottleneck.except
diff --git src/hg/lib/botDelay.c src/hg/lib/botDelay.c
index 25b499f..b09a27d 100644
--- src/hg/lib/botDelay.c
+++ src/hg/lib/botDelay.c
@@ -1,137 +1,168 @@
 /* botDelay.c - contact bottleneck server and sleep 
  * for a little bit if IP address looks like it is
  * being just too demanding. */
 
 #include "common.h"
 #include "net.h"
 #include "portable.h"
 #include "hgConfig.h"
 #include "cheapcgi.h"
 #include "hui.h"
 #include "hCommon.h"
 #include "botDelay.h"
 
 
 int botDelayTime(char *host, int port, char *botCheckString)
 /* Figure out suggested delay time for ip address in
  * milliseconds. */
 {
 int sd = netMustConnect(host, port);
 char buf[256];
 netSendString(sd, botCheckString);
 netRecieveString(sd, buf);
 close(sd);
 return atoi(buf);
 }
 
 void botDelayMessage(char *ip, int millis)
 /* Print out message saying why you are stalled. */
 {
 time_t now = time(NULL);
 printf("<BR>There is a very high volume of traffic coming from your "
        "site (IP address %s) as of %s (California time).  So that other "
        "users get a fair share "
        "of our bandwidth, we are putting in a delay of %3.1f seconds "
        "before we service your request.  This delay will slowly "
        "decrease over a half hour as activity returns to normal.  This "
        "high volume of traffic is likely due to program-driven rather than "
        "interactive access, or the submission of queries on a large "
        "number of sequences.  If you are making large batch queries, "
        "please write to our genome@cse.ucsc.edu public mailing list "
        "and inquire about more efficient ways to access our data.  "
        "If you are sharing an IP address with someone who is submitting "
        "large batch queries, we apologize for the "
        "inconvenience. Please contact genome-www@cse.ucsc.edu if "
        "you think this delay is being imposed unfairly.<BR><HR>", 
 	    ip, asctime(localtime(&now)), .001*millis);
 }
 
 void botTerminateMessage(char *ip, int millis)
 /* Print out message saying why you are terminated. */
 {
 time_t now = time(NULL);
 hUserAbort("There is an exceedingly high volume of traffic coming from your "
        "site (IP address %s) as of %s (California time).  It looks like "
        "a web robot is launching queries quickly, and not even waiting for "
        "the results of one query to finish before launching another query. "
        "/* We cannot service requests from your IP address under */ these "
        "conditions.  (code %d)", ip, asctime(localtime(&now)), millis);
 }
 
 static char *getCookieUser()
 /* get user from hguid cookie */
 {
 char *user = NULL;
 char *centralCookie = hUserCookie();
 
 if (centralCookie)
     user = findCookieData(centralCookie);
 
 return user;
 }
 
 static char *getBotCheckString(char *ip)
 /* compose user.ip string for bot check */
 {
 char *user = getCookieUser();
 char *botCheckString = needMem(256);
 if (user)
   safef(botCheckString, 256, "%s.%s", user, ip);
 else
   safef(botCheckString, 256, "%s", ip);
 return botCheckString;
 }
 
 void botDelayCgi(char *host, int port)
 /* Connect with bottleneck server and sleep the
  * amount it suggests for IP address calling CGI script. */
 {
 int millis;
 char *ip = getenv("REMOTE_ADDR");
 if (ip != NULL)
     {
     char *botCheckString = getBotCheckString(ip);    
     millis = botDelayTime(host, port, botCheckString);
     freeMem(botCheckString);
     if (millis > 0)
 	{
 	if (millis > 10000)
 	    {
 	    if (millis > 20000)
 	        botTerminateMessage(ip, millis);
 	    else
 		botDelayMessage(ip, millis);
 	    }
 	sleep1000(millis);
 	}
     }
 }
 
+boolean botException()
+/* check if the remote ip address is on the exceptions list */
+{
+char *exceptIps = cfgOption("bottleneck.except");
+if (exceptIps)
+    {
+    char *remoteAddr = getenv("REMOTE_ADDR");
+    if (remoteAddr)
+	{
+	char *s = exceptIps;
+	boolean found = FALSE;
+	while (s && !found)
+	    {
+	    char *e = strchr(s, ' ');
+	    if (e)
+		*e = 0;
+	    if (sameString(remoteAddr, s))
+		found = TRUE;
+	    if (e)
+		*e++ = ' ';
+	    s = e;
+	    }
+	if (found)
+	    return TRUE;
+	}
+    }
+return FALSE;
+}
 void hgBotDelay()
 /* High level bot delay call - looks up bottleneck server
  * in hg.conf. */
 {
+if (botException())
+    return;
+
 char *host = cfgOption("bottleneck.host");
 char *port = cfgOption("bottleneck.port");
 
 if (host != NULL && port != NULL)
     botDelayCgi(host, atoi(port));
 }
 
 int hgBotDelayTime()
 /* Get suggested delay time from cgi. */
 {
 char *ip = getenv("REMOTE_ADDR");
 char *host = cfgOption("bottleneck.host");
 char *port = cfgOption("bottleneck.port");
 
 int delay = 0;
 if (host != NULL && port != NULL && ip != NULL)
     {
     char *botCheckString = getBotCheckString(ip);    
     delay = botDelayTime(host, atoi(port), botCheckString);
     freeMem(botCheckString);
     }
 return delay;
 }