]> git.ipfire.org Git - thirdparty/sarg.git/blobdiff - userinfo.c
Add support to decompress xz files
[thirdparty/sarg.git] / userinfo.c
index 4339ba6ad816d4b11e30de8e16732d669847b163..c502d89033139435368ab10635d5da6131b2e70e 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * SARG Squid Analysis Report Generator      http://sarg.sourceforge.net
- *                                                            1998, 2011
+ *                                                            1998, 2015
  *
  * SARG donations:
  *      please look at http://sarg.sourceforge.net/donations.php
@@ -26,6 +26,8 @@
 
 #include "include/conf.h"
 #include "include/defs.h"
+#include "include/stringbuffer.h"
+#include "include/alias.h"
 
 //! The number of users to group in one unit.
 #define USERS_PER_GROUP 50
@@ -58,8 +60,17 @@ struct userscanstruct
 static struct usergroupstruct *first_user_group=NULL;
 //! The counter to generate unique user number when ::AnonymousOutputFiles is set.
 static int AnonymousCounter=0;
+//! String buffer to store the user's related constants.
+static StringBufferObject UserStrings=NULL;
+//! User aliases.
+static AliasObject UserAliases=NULL;
 
-struct userinfostruct *userinfo_create(const char *userid)
+extern struct ReadLogDataStruct ReadFilter;
+extern char StripUserSuffix[MAX_USER_LEN];
+extern int StripSuffixLen;
+extern char *userfile;
+
+struct userinfostruct *userinfo_create(const char *userid,const char *ip)
 {
        struct usergroupstruct *group, *last;
        struct userinfostruct *user;
@@ -68,6 +79,15 @@ struct userinfostruct *userinfo_create(const char *userid)
        int flen;
        int count, clen;
        char cstr[9];
+       char filename[MAX_USER_FNAME_LEN];
+
+       if (!UserStrings) {
+               UserStrings=StringBuffer_Create();
+               if (!UserStrings) {
+                       debuga(__FILE__,__LINE__,_("Not enough memory to store the user's strings\n"));
+                       exit(EXIT_FAILURE);
+               }
+       }
 
        last=NULL;
        for (group=first_user_group ; group ; group=group->next) {
@@ -78,7 +98,7 @@ struct userinfostruct *userinfo_create(const char *userid)
        if (!group) {
                group=malloc(sizeof(*group));
                if (!group) {
-                       debuga(_("Not enough memory to store the user\n"));
+                       debuga(__FILE__,__LINE__,_("Not enough memory to store user \"%s\"\n"),userid);
                        exit(EXIT_FAILURE);
                }
                memset(group,0,sizeof(*group));
@@ -89,41 +109,67 @@ struct userinfostruct *userinfo_create(const char *userid)
        }
        user=group->list+group->nusers++;
 
-       safe_strcpy(user->id,userid,sizeof(user->id));
+       user->id=StringBuffer_Store(UserStrings,userid);
+       if (!user->id) {
+               debuga(__FILE__,__LINE__,_("Not enough memory to store user ID \"%s\"\n"),userid);
+               exit(EXIT_FAILURE);
+       }
+       user->label=user->id; //assign a label to avoid a NULL pointer in case none is provided
+       if (ip) {
+               /*
+                * IP address is not the same as the user's ID. A separate buffer
+                * must be allocated.
+                */
+               user->id_is_ip=false;
+               user->ip=StringBuffer_Store(UserStrings,ip);
+       } else {
+               /*
+                * User's IP address share the same buffer as the user's ID.
+                */
+               user->id_is_ip=true;
+               user->ip=user->id;
+       }
 
        if (AnonymousOutputFiles) {
-               snprintf(user->filename,sizeof(user->filename),"%d",AnonymousCounter++);
+               snprintf(filename,sizeof(filename),"%d",AnonymousCounter++);
        } else {
                skip=0;
                j=0;
                for (i=0 ; userid[i] && j<MAX_USER_FNAME_LEN-1 ; i++) {
                        if (isalnum(userid[i]) || userid[i]=='-' || userid[i]=='_') {
-                               user->filename[j++]=userid[i];
+                               filename[j++]=userid[i];
                                skip=0;
                        } else {
                                if (!skip) {
-                                       user->filename[j++]='_';
+                                       filename[j++]='_';
                                        skip=1;
                                }
                        }
                }
-               user->filename[j]='\0';
-               flen=i-1;
+               if (j==0) filename[j++]='_'; //don't leave a file name empty
+               flen=j;
+               filename[j]='\0';
 
                count=0;
                for (group=first_user_group ; group ; group=group->next) {
                        lastuser=(group->next) ? group->nusers : group->nusers-1;
                        for (i=0 ; i<lastuser ; i++) {
-                               if (strcasecmp(user->filename,group->list[i].filename)==0) {
-                                       clen=sprintf(cstr,"-%04X",count++);
+                               if (strcasecmp(filename,group->list[i].filename)==0) {
+                                       clen=sprintf(cstr,"+%X",count++);
                                        if (flen+clen<MAX_USER_FNAME_LEN)
-                                               strcpy(user->filename+flen,cstr);
+                                               strcpy(filename+flen,cstr);
                                        else
-                                               strcpy(user->filename+MAX_USER_FNAME_LEN-clen,cstr);
+                                               strcpy(filename+MAX_USER_FNAME_LEN-clen,cstr);
                                }
                        }
                }
        }
+       user->filename=StringBuffer_Store(UserStrings,filename);
+       if (!user->filename)
+       {
+               debuga(__FILE__,__LINE__,_("Not enough memory to store the file name for user \"%s\"\n"),user->id);
+               exit(EXIT_FAILURE);
+       }
 
        return(user);
 }
@@ -137,6 +183,23 @@ void userinfo_free(void)
                free(group);
        }
        first_user_group=NULL;
+       StringBuffer_Destroy(&UserStrings);
+}
+
+/*!
+ * Store the user's label.
+ * \param uinfo The user info structure created by userinfo_create().
+ * \param label The string label to store.
+ */
+void userinfo_label(struct userinfostruct *uinfo,const char *label)
+{
+       if (!uinfo) return;
+       if (!UserStrings) return;
+       uinfo->label=StringBuffer_Store(UserStrings,label);
+       if (!uinfo->label) {
+               debuga(__FILE__,__LINE__,_("Not enough memory to store label \"%s\" of user \"%s\"\n"),label,uinfo->id);
+               exit(EXIT_FAILURE);
+       }
 }
 
 struct userinfostruct *userinfo_find_from_file(const char *filename)
@@ -165,6 +228,19 @@ struct userinfostruct *userinfo_find_from_id(const char *id)
        return(NULL);
 }
 
+struct userinfostruct *userinfo_find_from_ip(const char *ip)
+{
+       struct usergroupstruct *group;
+       int i;
+
+       for (group=first_user_group ; group ; group=group->next) {
+               for (i=0 ; i<group->nusers ; i++)
+                       if (strcmp(ip,group->list[i].ip)==0)
+                               return(group->list+i);
+       }
+       return(NULL);
+}
+
 /*!
 Start the scanning of the user list.
 
@@ -218,3 +294,175 @@ struct userinfostruct *userinfo_advancescan(userscan uscan)
        }
        return(uinfo);
 }
+
+/*!
+Clear the general purpose flag from all the user's info.
+*/
+void userinfo_clearflag(void)
+{
+       struct usergroupstruct *group;
+       int i;
+
+       for (group=first_user_group ; group ; group=group->next) {
+               for (i=0 ; i<group->nusers ; i++)
+                       group->list[i].flag=0;
+       }
+}
+
+/*!
+Read the file containing the user names to alias in the report.
+
+\param Filename The name of the file.
+*/
+void read_useralias(const char *Filename)
+{
+       FileObject *fi;
+       longline line;
+       char *buf;
+
+       if (debug) debuga(__FILE__,__LINE__,_("Reading user alias file \"%s\"\n"),Filename);
+
+       UserAliases=Alias_Create();
+       if (!UserAliases) {
+               debuga(__FILE__,__LINE__,_("Cannot store user's aliases\n"));
+               exit(EXIT_FAILURE);
+       }
+
+       fi=FileObject_Open(Filename);
+       if (!fi) {
+               debuga(__FILE__,__LINE__,_("Cannot read user name alias file \"%s\": %s\n"),Filename,FileObject_GetLastOpenError());
+               exit(EXIT_FAILURE);
+       }
+
+       if ((line=longline_create())==NULL) {
+               debuga(__FILE__,__LINE__,_("Not enough memory to read file \"%s\"\n"),Filename);
+               exit(EXIT_FAILURE);
+       }
+
+       while ((buf=longline_read(fi,line)) != NULL) {
+               if (Alias_Store(UserAliases,buf)<0) {
+                       debuga(__FILE__,__LINE__,_("While reading \"%s\"\n"),Filename);
+                       exit(EXIT_FAILURE);
+               }
+       }
+
+       longline_destroy(&line);
+       if (FileObject_Close(fi)) {
+               debuga(__FILE__,__LINE__,_("Read error in \"%s\": %s\n"),Filename,FileObject_GetLastCloseError());
+               exit(EXIT_FAILURE);
+       }
+
+       if (debug) {
+               debuga(__FILE__,__LINE__,_("List of user names to alias:\n"));
+               Alias_PrintList(UserAliases);
+       }
+}
+
+/*!
+Free the memory allocated by read_useralias().
+*/
+void free_useralias(void)
+{
+       Alias_Destroy(&UserAliases);
+}
+
+/*!
+Replace the user's name or ID by an alias if one is defined.
+
+\param user The user's name or ID as extracted from the report.
+
+\retval USERERR_NoError No error.
+\retval USERERR_NameTooLong User name too long.
+*/
+enum UserProcessError process_user(const char **UserPtr,const char *IpAddress,bool *IsIp)
+{
+       const char *user=*UserPtr;
+       static char UserBuffer[MAX_USER_LEN];
+       const char *auser;
+
+       if (UserIp) {
+               user=IpAddress;
+               *IsIp=true;
+       } else {
+               *IsIp=false;
+
+               if (StripSuffixLen>0)
+               {
+                       int x=strlen(user);
+                       if (x>StripSuffixLen && strcasecmp(user+(x-StripSuffixLen),StripUserSuffix)==0)
+                       {
+                               if (x-StripSuffixLen>=sizeof(UserBuffer))
+                                       return(USERERR_NameTooLong);
+                               safe_strcpy(UserBuffer,user,x-StripSuffixLen+1);
+                               user=UserBuffer;
+                       }
+               }
+               if (strlen(user)>MAX_USER_LEN)
+                       return(USERERR_NameTooLong);
+
+               if (testvaliduserchar(user))
+                       return(USERERR_InvalidChar);
+
+               if ((user[0]=='\0') || (user[1]=='\0' && (user[0]=='-' || user[0]==' '))) {
+                       if(RecordsWithoutUser == RECORDWITHOUTUSER_IP) {
+                               user=IpAddress;
+                               *IsIp=true;
+                       }
+                       if (RecordsWithoutUser == RECORDWITHOUTUSER_IGNORE)
+                               return(USERERR_EmptyUser);
+                       if (RecordsWithoutUser == RECORDWITHOUTUSER_EVERYBODY)
+                               user="everybody";
+               } else {
+                       if (NtlmUserFormat == NTLMUSERFORMAT_USER) {
+                               const char *str;
+                               if ((str=strchr(user,'+'))!=NULL || (str=strchr(user,'\\'))!=NULL || (str=strchr(user,'_'))!=NULL) {
+                                       user=str+1;
+                               }
+                       }
+               }
+       }
+
+       if (us[0]!='\0' && strcmp(user,us)!=0)
+               return(USERERR_Untracked);
+
+       if (ReadFilter.SysUsers) {
+               char wuser[MAX_USER_LEN+2]=":";
+
+               strcat(wuser,user);
+               strcat(wuser,":");
+               if (strstr(userfile, wuser) == 0)
+                       return(USERERR_SysUser);
+       }
+
+       if (ReadFilter.UserFilter) {
+               if (!vuexclude(user)) {
+                       if (debugz>=LogLevel_Process) debuga(__FILE__,__LINE__,_("Excluded user: %s\n"),user);
+                       return(USERERR_Ignored);
+               }
+       }
+
+       auser=Alias_Replace(UserAliases,user);
+       if (auser!=user) {
+               if (*auser==ALIAS_PREFIX) auser++;//no need for that indicator for a user name
+               user=auser;
+               *IsIp=false;
+       }
+
+       // include_users
+       if (IncludeUsers[0] != '\0') {
+               char wuser[MAX_USER_LEN+2]=":";
+               char *str;
+
+               strcat(wuser,user);
+               strcat(wuser,":");
+               str=strstr(IncludeUsers,wuser);
+               if (!str)
+                       return(USERERR_Excluded);
+       }
+
+       if (user[0]=='\0' || (user[1]=='\0' && (user[0]=='-' || user[0]==' ' || user[0]==':')))
+               return(USERERR_EmptyUser);
+
+       *UserPtr=user;
+       return(USERERR_NoError);
+}