FOSSology  4.7.1
Open Source License Compliance by Open Source Software
ununpack.h
1 /*
2  Ununpack: The universal unpacker.
3 
4  SPDX-FileCopyrightText: © 2007-2011 Hewlett-Packard Development Company, L.P.
5 
6  SPDX-License-Identifier: GPL-2.0-only
7 
8  This time, it's rewritten in C for speed and multithreading.
9 */
10 #ifndef UNUNPACK_H
11 #define UNUNPACK_H
12 
13 
14 #include <ctype.h>
15 #include <dirent.h>
16 #include <errno.h>
17 #include <fcntl.h>
18 #include <magic.h>
19 #include <signal.h>
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <time.h>
24 #include <unistd.h>
25 #include <libgen.h>
26 
27 #include <sys/mman.h>
28 #include <sys/stat.h>
29 #include <sys/time.h>
30 //#include <sys/timeb.h>
31 #include <sys/types.h>
32 #include <sys/wait.h>
33 
34 #include "checksum.h"
35 #include "ununpack-ar.h"
36 #include "ununpack-disk.h"
37 #include "ununpack-lzip.h"
38 #include "ununpack-iso.h"
39 #include "ununpack-zstd.h"
40 
41 #ifdef STANDALONE
42 #include "standalone.h"
43 #else
44 #include "libfossology.h"
45 #endif
46 
47 #define Last(x) (x)[strlen(x)-1]
48 #define DEFAULT_PDF_CMD_TIMEOUT 200
49 #define DEFAULT_CMD_MEM_LIMIT_KB (2L * 1024 * 1024) /* 2 GiB */
50 #define MAXCHILD 4096
51 #define MAXSQL 4096
52 #define PATH_MAX 4096
53 
57 enum cmdtype
58 {
59  CMD_NULL=0,
60  CMD_PACK,
61  CMD_RPM,
62  CMD_ARC,
63  CMD_AR,
64  CMD_PARTITION,
65  CMD_ISO,
66  CMD_DISK,
67  CMD_DEB,
68  CMD_ZSTD,
69  CMD_LZIP,
70  CMD_DEFAULT
71 };
72 
73 typedef enum cmdtype cmdtype;
79 struct ParentInfo
80 {
81  int Cmd;
82  time_t StartTime;
83  time_t EndTime;
86 };
87 typedef struct ParentInfo ParentInfo;
88 
93 {
94  int ChildPid;
95  char ChildRecurse[FILENAME_MAX+1];
98  int ChildEnd;
100  struct stat ChildStat;
102 };
103 typedef struct unpackqueue unpackqueue;
104 
108 struct dirlist
109 {
110  char *Name;
111  struct dirlist *Next;
112 };
113 typedef struct dirlist dirlist;
114 
120 {
121  char Source[FILENAME_MAX];
122  char Partdir[FILENAME_MAX];
123  char Partname[FILENAME_MAX];
124  char PartnameNew[FILENAME_MAX];
126  int HasChild;
127  int Pruned;
128  int Corrupt;
129  struct stat Stat;
131  int Artifact;
132  int IsDir;
135  long pfile_pk;
136  long ufile_mode;
137 };
138 typedef struct ContainerInfo ContainerInfo;
139 
146 struct cmdlist
147 {
148  char * Magic;
149  char * Cmd;
150  char * CmdPre;
151  char * CmdPost;
152  char * MetaCmd;
153  cmdtype Type;
154  int Status;
157  long DBindex;
158 };
159 typedef struct cmdlist cmdlist;
160 
161 /* utils.c */
162 int IsInflatedFile(char *FileName, int InflateSize);
163 int IsDebianSourceFile(char *Filename);
164 int IsCpioFile(char *Filename);
165 void SafeExit (int rc);
166 void RemovePostfix(char *Name);
167 void InitCmd ();
168 int TaintString (char *Dest, int DestLen, char *Src, int ProtectQuotes, char *Replace);
169 extern int Prune (char *Fname, struct stat Stat);
170 extern int MkDirs (char *Fname);
171 extern int MkDir (char *Fname);
172 extern int IsDir (char *Fname);
173 extern int RemoveDir (char *dirpath);
174 int IsFile (char *Fname, int Link);
175 int ReadLine (FILE *Fin, char *Line, int MaxLine);
176 int IsExe (char *Exe, int Quiet);
177 int CopyFile (char *Src, char *Dst);
178 int ParentWait();
179 void CheckCommands (int Show);
180 int RunCommand (char *Cmd, char *CmdPre, char *File, char *CmdPost, char *Out, char *Where);
181 int IsPdfProcessable (const char *QuotedPath);
182 int InitMagic();
183 int FindCmd (char *Filename);
184 void FreeDirList (dirlist *DL);
185 dirlist * MakeDirList (char *Fullname);
186 void SetDir (char *Dest, int DestLen, char *Smain, char *Sfile);
188 int DBInsertPfile (ContainerInfo *CI, char *Fuid);
189 int DBInsertUploadTree (ContainerInfo *CI, int Mask);
190 int AddToRepository (ContainerInfo *CI, char *Fuid, int Mask);
191 int DisplayContainerInfo (ContainerInfo *CI, int Cmd);
192 char *PathCheck(char *DirPath);
193 void Usage (char *Name, char *Version);
194 void deleteTmpFiles(char *dir);
195 void SQLNoticeProcessor(void *arg, const char *message);
196 int ShouldExclude(char *Filename, const char *ExcludePatterns);
197 
198 
199 /* traverse.c */
200 void TraverseStart (char *Filename, char *Label, char *NewDir, int Recurse, char *ExcludePatterns);
201 void TraverseChild (int Index, ContainerInfo *CI, char *NewDir);
202 int Traverse (char *Filename, char *Basename, char *Label, char *NewDir, int Recurse, ParentInfo *PI, char *ExcludePatterns);
203 
204 #endif
205 
int Quiet
Run in quiet mode?
char * TaintString(char *S)
Create a string with taint quoting.
Definition: finder.c:35
Usage()
Print Usage statement.
Definition: fo_dbcheck.php:81
The main FOSSology C library.
void CopyFile(char *Source, char *Type, char *Name)
Definition: repcopyin.c:39
int ReadLine(FILE *Fin, char *Line, int MaxLine)
Definition: repcopyin.c:64
Structure for storing information about a particular file.
Definition: ununpack.h:120
int IsCompressed
Definition: ununpack.h:133
long pfile_pk
Definition: ununpack.h:135
int TopContainer
Definition: ununpack.h:125
ParentInfo PI
Definition: ununpack.h:130
char Partname[FILENAME_MAX]
Definition: ununpack.h:123
long uploadtree_pk
Definition: ununpack.h:134
long ufile_mode
Definition: ununpack.h:136
struct stat Stat
Definition: ununpack.h:129
char PartnameNew[FILENAME_MAX]
Definition: ununpack.h:124
char Partdir[FILENAME_MAX]
Definition: ununpack.h:122
Definition: monk.h:61
time_t StartTime
Definition: ununpack.h:82
long uploadtree_pk
Definition: ununpack.h:85
int ChildRecurseArtifact
Definition: ununpack.h:84
time_t EndTime
Definition: ununpack.h:83
Command table's single row.
Definition: ununpack.h:147
cmdtype Type
Definition: ununpack.h:153
long DBindex
Definition: ununpack.h:157
int Status
Definition: ununpack.h:154
char * MetaCmd
Definition: ununpack.h:152
char * Cmd
Definition: ununpack.h:149
int ModeMaskReg
Definition: ununpack.h:156
char * CmdPost
Definition: ununpack.h:151
char * CmdPre
Definition: ununpack.h:150
int ModeMaskDir
Definition: ununpack.h:155
Directory linked list.
Definition: ununpack.h:109
struct dirlist * Next
Definition: ununpack.h:111
Queue for files to be unpacked.
Definition: ununpack.h:93
int ChildStatus
Definition: ununpack.h:96
ParentInfo PI
Definition: ununpack.h:101
struct stat ChildStat
Definition: ununpack.h:100
int ChildEnd
Definition: ununpack.h:98
char ChildRecurse[FILENAME_MAX+1]
Definition: ununpack.h:95
int ChildCorrupt
Definition: ununpack.h:97
int ChildHasChild
Definition: ununpack.h:99
static char * Dst
Destination location.
Definition: test_CopyFile.c:14
static char * Src
Souce location.
Definition: test_CopyFile.c:13
void TraverseStart(char *Filename, char *Label, char *NewDir, int Recurse, char *ExcludePatterns)
Find all files (assuming a directory) and process (unpack) all of them.
Definition: traverse.c:24
void TraverseChild(int Index, ContainerInfo *CI, char *NewDir)
Called by exec'd child to process.
Definition: traverse.c:96
int Traverse(char *Filename, char *Basename, char *Label, char *NewDir, int Recurse, ParentInfo *PI, char *ExcludePatterns)
Find all files, traverse all directories. This is a depth-first search, in inode order!
Definition: traverse.c:279
int RunCommand(char *Cmd, char *CmdPre, char *File, char *CmdPost, char *Out, char *Where)
Try a command and return command code.
Definition: utils.c:667
int DisplayContainerInfo(ContainerInfo *CI, int Cmd)
Print what can be printed in XML.
Definition: utils.c:1597
void DebugContainerInfo(ContainerInfo *CI)
Print a ContainerInfo structure.
Definition: utils.c:1225
int RemoveDir(char *dirpath)
Remove all files under dirpath (rm -rf)
Definition: utils.c:1781
int MkDirs(char *Fname)
Same as command-line "mkdir -p".
Definition: utils.c:256
int Prune(char *Fname, struct stat Stat)
Given a filename and its stat, prune it.
Definition: utils.c:225
int IsCpioFile(char *Filename)
Check the leading magic bytes for a cpio archive.
Definition: utils.c:882
int InitMagic()
Open and load Magic file Initializes global MagicCookie.
Definition: utils.c:821
void CheckCommands(int Show)
Make sure all commands are usable.
Definition: utils.c:575
int IsDebianSourceFile(char *Filename)
Read file to see if it is a Debian source file.
Definition: utils.c:839
int MkDir(char *Fname)
Smart mkdir.
Definition: utils.c:311
void SetDir(char *Dest, int DestLen, char *Smain, char *Sfile)
Set a destination directory name.
Definition: utils.c:1187
int ParentWait()
Wait for a child. Sets child status.
Definition: utils.c:517
void RemovePostfix(char *Name)
get rid of the postfix
Definition: utils.c:98
int AddToRepository(ContainerInfo *CI, char *Fuid, int Mask)
Add a ContainerInfo record to the repository AND to the database.
Definition: utils.c:1542
void FreeDirList(dirlist *DL)
Free a list of files in a directory list.
Definition: utils.c:1091
int DBInsertPfile(ContainerInfo *CI, char *Fuid)
Insert a Pfile record. Sets the pfile_pk in CI.
Definition: utils.c:1254
int DBInsertUploadTree(ContainerInfo *CI, int Mask)
Insert an UploadTree record.
Definition: utils.c:1426
int IsPdfProcessable(const char *QuotedPath)
Structurally validate a PDF before handing it to pdftotext.
Definition: utils.c:628
void InitCmd()
Initialize the metahandler CMD table.
Definition: utils.c:116
int IsExe(char *Exe, int Quiet)
Check if the executable exists.
Definition: utils.c:401
void SafeExit(int rc)
Close scheduler and database connections, then exit.
Definition: utils.c:85
int FindCmd(char *Filename)
Given a file name, determine the type of extraction command. This uses Magic.
Definition: utils.c:984
int ShouldExclude(char *Filename, const char *ExcludePatterns)
Determines if a file or folder should be excluded.
Definition: utils.c:1927
int IsInflatedFile(char *FileName, int InflateSize)
Test if the file is a compression bomb.
Definition: utils.c:41
char * PathCheck(char *DirPath)
Check if path contains a "%U" or "%H". If so, substitute a unique ID for U.
Definition: utils.c:1802
void SQLNoticeProcessor(void *arg, const char *message)
Dummy postgresql notice processor. This prevents Notices from being written to stderr.
Definition: utils.c:1912
dirlist * MakeDirList(char *Fullname)
Create a list of files in a directory.
Definition: utils.c:1110
int IsDir(char *Fname)
Given a filename, is it a directory?
Definition: utils.c:327
int Recurse
Level of unpack recursion. Default to infinite.
Definition: run_tests.c:19
char * NewDir
Test result directory.
Definition: run_tests.c:18
char * Filename
Filename.
Definition: run_tests.c:17
int IsFile(long mode)
Check if the pfile_id is a file.
Definition: wc_agent.c:55