1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
This file is part of libextractor.
(C) 2002, 2003, 2004, 2005, 2006, 2009 Vidyut Samanta and Christian Grothoff
libextractor is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2, or (at your
option) any later version.
libextractor 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 libextractor; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#if !defined (EXTRACTOR_PLUGINS_H)
#define EXTRACTOR_PLUGINS_H
#include "platform.h"
#include "plibc.h"
#include "extractor.h"
//#include <dirent.h>
//#include <sys/types.h>
#ifndef WINDOWS
#include <sys/wait.h>
#include <sys/shm.h>
#endif
#include <signal.h>
#include <ltdl.h>
/**
* Linked list of extractor plugins. An application builds this list
* by telling libextractor to load various keyword-extraction
* plugins. Libraries can also be unloaded (removed from this list,
* see EXTRACTOR_plugin_remove).
*/
struct EXTRACTOR_PluginList
{
/**
* This is a linked list.
*/
struct EXTRACTOR_PluginList *next;
/**
* Pointer to the plugin (as returned by lt_dlopen).
*/
void * libraryHandle;
/**
* Name of the library (i.e., 'libextractor_foo.so')
*/
char *libname;
/**
* Name of the library (i.e., 'libextractor_foo.so')
*/
char *short_libname;
/**
* Pointer to the function used for meta data extraction.
*/
EXTRACTOR_extract_method extract_method;
EXTRACTOR_init_state_method init_state_method;
EXTRACTOR_discard_state_method discard_state_method;
/**
* Options for the plugin.
*/
char * plugin_options;
/**
* Special options for the plugin
* (as returned by the plugin's "options" method;
* typically NULL).
*/
const char *specials;
/**
* Flags to control how the plugin is executed.
*/
enum EXTRACTOR_Options flags;
/**
* Process ID of the child process for this plugin. 0 for none.
*/
#if !WINDOWS
int cpid;
#else
HANDLE hProcess;
#endif
/**
* Pipe used to communicate information to the plugin child process.
* NULL if not initialized.
*/
#if !WINDOWS
FILE *cpipe_in;
#else
HANDLE cpipe_in;
#endif
/**
* A position this plugin wants us to seek to. -1 if it's finished.
* Starts at 0;
*/
int64_t seek_request;
#if !WINDOWS
int shm_id;
#else
HANDLE map_handle;
#endif
void *state;
int64_t fsize;
int64_t position;
unsigned char *shm_ptr;
size_t map_size;
/**
* Pipe used to read information about extracted meta data from
* the plugin child process. -1 if not initialized.
*/
#if !WINDOWS
int cpipe_out;
#else
HANDLE cpipe_out;
#endif
#if WINDOWS
/**
* A structure for overlapped reads on W32.
*/
OVERLAPPED ov_read;
/**
* A structure for overlapped writes on W32.
*/
OVERLAPPED ov_write;
/**
* A write buffer for overlapped writes on W32
*/
unsigned char *ov_write_buffer;
#endif
};
/**
* Load a plugin.
*
* @param plugin plugin to load
* @return 0 on success, -1 on error
*/
int
plugin_load (struct EXTRACTOR_PluginList *plugin);
#endif /* EXTRACTOR_PLUGINS_H */
|
