03aa97fd75ac9a1f0ea225ae6183be4cca53c9fe
[vlc.git] / include / vlc_addons.h
1 /*****************************************************************************
2  * vlc_addons.h : addons handling and describing
3  *****************************************************************************
4  * Copyright (C) 2013 VideoLAN and authors
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 #ifndef VLC_ADDONS_H
22 #define VLC_ADDONS_H 1
23
24 #include <vlc_arrays.h>
25 #include <vlc_events.h>
26
27 # ifdef __cplusplus
28 extern "C" {
29 # endif
30
31 typedef enum addon_type_t
32 {
33     ADDON_UNKNOWN = 0,
34     ADDON_EXTENSION,
35     ADDON_PLAYLIST_PARSER,
36     ADDON_SERVICE_DISCOVERY,
37     ADDON_SKIN2,
38     ADDON_PLUGIN,
39     ADDON_OTHER
40 } addon_type_t;
41
42 typedef enum addon_state_t
43 {
44     ADDON_NOTINSTALLED = 0,
45     ADDON_INSTALLING,
46     ADDON_INSTALLED,
47     ADDON_UNINSTALLING
48 } addon_state_t;
49
50 typedef enum addon_flags_t
51 {
52     ADDON_BROKEN     = 1, /* Have install inconsistency */
53     ADDON_MANAGEABLE = 1 << 1, /* Have manifest, can install or uninstall files */
54     ADDON_UPDATABLE  = 1 << 2,
55 } addon_flags_t;
56
57 #define ADDON_MAX_SCORE (5 * 100)
58 #define ADDON_UUID_SIZE 16
59 #define ADDON_UUID_PSZ_SIZE (ADDON_UUID_SIZE * 2 + 4)
60 typedef uint8_t addon_uuid_t[ADDON_UUID_SIZE];
61
62 typedef struct addon_file_t
63 {
64     addon_type_t e_filetype;
65     char *psz_download_uri;
66     char *psz_filename;
67 } addon_file_t;
68
69 struct addon_entry_t
70 {
71     vlc_mutex_t lock;
72
73     addon_type_t e_type;
74     addon_state_t e_state;
75     addon_flags_t e_flags;
76
77     /* data describing addon */
78     addon_uuid_t uuid;
79     char *psz_name;
80     char *psz_summary;
81     char *psz_description;
82     char *psz_author;
83     char *psz_source_uri; /* webpage, ... */
84     char *psz_image_uri;
85     char *psz_image_data; /* base64, png */
86     char *psz_version;
87
88     /* stats */
89     long int i_downloads;
90     int i_score; /* score 0..5 in hundredth */
91
92     /* Lister */
93     char *psz_source_module;
94
95     /* files list */
96     char *psz_archive_uri; /* Archive */
97     DECL_ARRAY(addon_file_t *) files;
98
99     /* custom data storage (if needed by module/source) */
100     void * p_custom;
101 };
102
103 typedef struct addons_finder_t addons_finder_t;
104 typedef struct addons_finder_sys_t addons_finder_sys_t;
105 struct addons_finder_t
106 {
107     VLC_COMMON_MEMBERS
108
109     int ( * pf_find )( addons_finder_t * );
110     int ( * pf_retrieve )( addons_finder_t *, addon_entry_t * );
111     DECL_ARRAY( addon_entry_t * ) entries;
112     char *psz_uri;
113
114     addons_finder_sys_t *p_sys;
115 };
116
117 typedef struct addons_storage_t addons_storage_t;
118 typedef struct addons_storage_sys_t addons_storage_sys_t;
119 struct addons_storage_t
120 {
121     VLC_COMMON_MEMBERS
122
123     int ( * pf_install )( addons_storage_t *, addon_entry_t * );
124     int ( * pf_remove )( addons_storage_t *, addon_entry_t * );
125     int ( * pf_catalog ) ( addons_storage_t *, addon_entry_t **, int );
126
127     addons_storage_sys_t *p_sys;
128 };
129
130 typedef struct addons_manager_private_t addons_manager_private_t;
131 struct addons_manager_t
132 {
133     vlc_event_manager_t * p_event_manager;
134
135     addons_manager_private_t *p_priv;
136 };
137 typedef struct addons_manager_t addons_manager_t;
138
139 /**
140  *  addon entry lifecycle
141  */
142 VLC_API addon_entry_t *addon_entry_New( void );
143 VLC_API addon_entry_t *addon_entry_Hold(addon_entry_t *);
144 VLC_API void addon_entry_Release(addon_entry_t *);
145
146 /**
147  * addons manager lifecycle
148  */
149 VLC_API addons_manager_t *addons_manager_New( vlc_object_t * );
150 VLC_API void addons_manager_Delete( addons_manager_t * );
151
152 /**
153  * Charge currently installed, usable and manageable addons
154  * (default "addons storage" module)
155  */
156 VLC_API int addons_manager_LoadCatalog( addons_manager_t * );
157
158 /**
159  * Gather addons info from repository (default "addons finder" module)
160  * If psz_uri is not NULL, only gather info from the pointed package.
161  */
162 VLC_API void addons_manager_Gather( addons_manager_t *, const char *psz_uri );
163
164 /**
165  * Install or Remove the addon identified by its uuid
166  */
167 VLC_API int addons_manager_Install( addons_manager_t *p_manager, const addon_uuid_t uuid );
168 VLC_API int addons_manager_Remove( addons_manager_t *p_manager, const addon_uuid_t uuid );
169
170 /**
171  * String uuid to binary uuid helpers
172  */
173 static inline bool addons_uuid_read( const char *psz_uuid, addon_uuid_t *p_uuid )
174 {
175     if ( !psz_uuid ) return false;
176     if ( strlen( psz_uuid ) < ADDON_UUID_PSZ_SIZE ) return false;
177
178     int i = 0, j = 0;
179     while ( i<ADDON_UUID_PSZ_SIZE )
180     {
181         if ( *( psz_uuid + i ) == '-' )
182             i++;
183         int v;
184         sscanf( psz_uuid + i, "%02x", &v );
185         (*p_uuid)[j++] = v & 0xFF;
186         i+=2;
187     }
188
189     return true;
190 }
191
192 static inline char * addons_uuid_to_psz( const addon_uuid_t * p_uuid )
193 {
194     char *psz = (char*) calloc( ADDON_UUID_PSZ_SIZE + 1 , sizeof(char) );
195     if ( psz )
196     {
197         int i=0;
198         char *p = psz;
199         while ( i < ADDON_UUID_SIZE )
200         {
201             if ( i == 4 || i== 7 || i== 9 || i== 11 )
202                 *p++ = '-';
203             int v = 0xFF & (*p_uuid)[i];
204             sprintf( p, "%02x", v );
205             p += 2;
206             i++;
207         }
208     }
209     return psz;
210 }
211
212 # ifdef __cplusplus
213 }
214 # endif
215
216 #endif