access: add ACCESS_IS_DIRECTORY as STREAM_IS_DIRECTORY
[vlc.git] / modules / access / smb.c
1 /*****************************************************************************
2  * smb.c: SMB input module
3  *****************************************************************************
4  * Copyright (C) 2001-2015 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <errno.h>
32 #ifdef _WIN32
33 #   include <fcntl.h>
34 #   include <sys/stat.h>
35 #   include <io.h>
36 #   define smbc_open(a,b,c) vlc_open(a,b,c)
37 #   define smbc_stat(a,b) _stati64(a,b)
38 #   define smbc_read read
39 #   define smbc_lseek _lseeki64
40 #   define smbc_close close
41 #else
42 #   include <libsmbclient.h>
43 #endif
44
45 #include <vlc_common.h>
46 #include <vlc_fs.h>
47 #include <vlc_plugin.h>
48 #include <vlc_access.h>
49 #include <vlc_input_item.h>
50
51 /*****************************************************************************
52  * Module descriptor
53  *****************************************************************************/
54 static int  Open ( vlc_object_t * );
55 static void Close( vlc_object_t * );
56
57 #define USER_TEXT N_("Username")
58 #define USER_LONGTEXT N_("Username that will be used for the connection, " \
59         "if no username is set in the URL.")
60 #define PASS_TEXT N_("Password")
61 #define PASS_LONGTEXT N_("Password that will be used for the connection, " \
62         "if no username or password are set in URL.")
63 #define DOMAIN_TEXT N_("SMB domain")
64 #define DOMAIN_LONGTEXT N_("Domain/Workgroup that " \
65     "will be used for the connection.")
66
67 #define SMB_HELP N_("Samba (Windows network shares) input")
68 vlc_module_begin ()
69     set_shortname( "SMB" )
70     set_description( N_("SMB input") )
71     set_help(SMB_HELP)
72     set_capability( "access", 0 )
73     set_category( CAT_INPUT )
74     set_subcategory( SUBCAT_INPUT_ACCESS )
75     add_string( "smb-user", NULL, USER_TEXT, USER_LONGTEXT,
76                 false )
77     add_password( "smb-pwd", NULL, PASS_TEXT,
78                   PASS_LONGTEXT, false )
79     add_string( "smb-domain", NULL, DOMAIN_TEXT,
80                 DOMAIN_LONGTEXT, false )
81     add_shortcut( "smb" )
82     set_callbacks( Open, Close )
83 vlc_module_end ()
84
85 /*****************************************************************************
86  * Local prototypes
87  *****************************************************************************/
88 static ssize_t Read( access_t *, uint8_t *, size_t );
89 static int Seek( access_t *, uint64_t );
90 static int Control( access_t *, int, va_list );
91 #ifndef _WIN32
92 static input_item_t* DirRead( access_t * );
93 static int DirControl( access_t *, int, va_list );
94 #endif
95
96 struct access_sys_t
97 {
98     int i_smb;
99     uint64_t size;
100 };
101
102 #ifdef _WIN32
103 static void Win32AddConnection( access_t *, char *, char *, char *, char * );
104 #else
105 static void smb_auth( const char *srv, const char *shr, char *wg, int wglen,
106                       char *un, int unlen, char *pw, int pwlen )
107 {
108     VLC_UNUSED(srv);
109     VLC_UNUSED(shr);
110     VLC_UNUSED(wg);
111     VLC_UNUSED(wglen);
112     VLC_UNUSED(un);
113     VLC_UNUSED(unlen);
114     VLC_UNUSED(pw);
115     VLC_UNUSED(pwlen);
116     //wglen = unlen = pwlen = 0;
117 }
118 #endif
119
120 /* Build an SMB URI
121  * smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]] */
122 static int smb_get_uri( access_t *p_access, char **ppsz_uri,
123                         const char *psz_domain,
124                         const char *psz_user, const char *psz_pwd,
125                         const char *psz_location, const char *psz_name )
126 {
127 #define PSZ_NAME_OR_NULL psz_name ? "/" : "", psz_name ? psz_name : ""
128 #ifdef _WIN32
129     if( psz_user )
130         Win32AddConnection( p_access, psz_location, psz_user, psz_pwd, psz_domain);
131     return asprintf( ppsz_uri, "//%s%s%s", psz_location, PSZ_NAME_OR_NULL );
132 #else
133     (void) p_access;
134     if( psz_user )
135         return asprintf( ppsz_uri, "smb://%s%s%s%s%s@%s%s%s",
136                          psz_domain ? psz_domain : "", psz_domain ? ";" : "",
137                          psz_user, psz_pwd ? ":" : "",
138                          psz_pwd ? psz_pwd : "", psz_location,
139                          PSZ_NAME_OR_NULL );
140     else
141         return asprintf( ppsz_uri, "smb://%s%s%s", psz_location,
142                          PSZ_NAME_OR_NULL );
143 #endif
144 }
145
146 /****************************************************************************
147  * Open: connect to smb server and ask for file
148  ****************************************************************************/
149 static int Open( vlc_object_t *p_this )
150 {
151     access_t     *p_access = (access_t*)p_this;
152     access_sys_t *p_sys;
153     struct stat  filestat;
154     char         *psz_location, *psz_uri = NULL;
155     char         *psz_user = NULL, *psz_pwd = NULL, *psz_domain = NULL;
156     int          i_ret;
157     int          i_smb;
158     uint64_t     i_size;
159
160     /* Parse input URI
161      * [[[domain;]user[:password@]]server[/share[/path[/file]]]]
162      * No need to search a user/pwd if there is no '/', indeed, user/pwd are
163      * set for a FILE_SHARE. */
164
165     psz_location = strchr( p_access->psz_location, '/' );
166     if( psz_location )
167     {
168         char *psz_tmp = strdup( p_access->psz_location );
169         char *psz_parser;
170
171         psz_tmp[ psz_location - p_access->psz_location ] = 0;
172         psz_location = p_access->psz_location;
173         psz_parser = strchr( psz_tmp, '@' );
174         if( psz_parser )
175         {
176             /* User info is there */
177             *psz_parser = 0;
178             psz_location = p_access->psz_location + (psz_parser - psz_tmp) + 1;
179
180             psz_parser = strchr( psz_tmp, ':' );
181             if( psz_parser )
182             {
183                 /* Password found */
184                 psz_pwd = strdup( psz_parser+1 );
185                 *psz_parser = 0;
186             }
187
188             psz_parser = strchr( psz_tmp, ';' );
189             if( psz_parser )
190             {
191                 /* Domain found */
192                 *psz_parser = 0; psz_parser++;
193                 psz_domain = strdup( psz_tmp );
194             }
195             else psz_parser = psz_tmp;
196
197             psz_user = strdup( psz_parser );
198         }
199
200         free( psz_tmp );
201
202         if( !psz_user ) psz_user = var_InheritString( p_access, "smb-user" );
203         if( psz_user && !*psz_user ) { free( psz_user ); psz_user = NULL; }
204         if( !psz_pwd ) psz_pwd = var_InheritString( p_access, "smb-pwd" );
205         if( psz_pwd && !*psz_pwd ) { free( psz_pwd ); psz_pwd = NULL; }
206         if( !psz_domain ) psz_domain = var_InheritString( p_access, "smb-domain" );
207         if( psz_domain && !*psz_domain ) { free( psz_domain ); psz_domain = NULL; }
208     } else
209         psz_location = p_access->psz_location;
210
211     i_ret = smb_get_uri( p_access, &psz_uri, psz_domain, psz_user, psz_pwd,
212                          psz_location, NULL );
213
214     free( psz_user );
215     free( psz_pwd );
216     free( psz_domain );
217
218     if( i_ret == -1 )
219         return VLC_ENOMEM;
220
221 #ifndef _WIN32
222     if( smbc_init( smb_auth, 0 ) )
223     {
224         free( psz_uri );
225         return VLC_EGENERIC;
226     }
227 #endif
228
229 /*
230 ** some version of glibc defines open as a macro, causing havoc
231 ** with other macros using 'open' under the hood, such as the
232 ** following one:
233 */
234 #if defined(smbc_open) && defined(open)
235 # undef open
236 #endif
237
238     /* Init p_access */
239     access_InitFields( p_access );
240     p_sys =
241     p_access->p_sys = (access_sys_t*)calloc( 1, sizeof( access_sys_t ) );
242     if( !p_sys )
243     {
244         free( psz_uri );
245         return VLC_ENOMEM;
246     }
247
248     i_ret = smbc_stat( psz_uri, &filestat );
249
250     /* smbc_stat fails with servers or shares. Assume they are directory */
251     if( i_ret || S_ISDIR( filestat.st_mode ) )
252     {
253 #ifdef _WIN32
254         return VLC_EGENERIC;
255 #else
256         p_access->pf_readdir = DirRead;
257         p_access->pf_control = DirControl;
258         i_smb = smbc_opendir( psz_uri );
259         i_size = 0;
260 #endif
261     }
262     else
263     {
264         ACCESS_SET_CALLBACKS( Read, NULL, Control, Seek );
265         i_smb = smbc_open( psz_uri, O_RDONLY, 0 );
266         i_size = filestat.st_size;
267     }
268     free( psz_uri );
269
270     if( i_smb < 0 )
271     {
272         msg_Err( p_access, "open failed for '%s' (%s)",
273                  p_access->psz_location, vlc_strerror_c(errno) );
274         free( p_sys );
275         return VLC_EGENERIC;
276     }
277
278     p_sys->size = i_size;
279     p_sys->i_smb = i_smb;
280
281     return VLC_SUCCESS;
282 }
283
284 /*****************************************************************************
285  * Close: free unused data structures
286  *****************************************************************************/
287 static void Close( vlc_object_t *p_this )
288 {
289     access_t     *p_access = (access_t*)p_this;
290     access_sys_t *p_sys = p_access->p_sys;
291
292 #ifndef _WIN32
293     if( p_access->pf_readdir )
294         smbc_closedir( p_sys->i_smb );
295     else
296 #endif
297         smbc_close( p_sys->i_smb );
298 }
299
300 /*****************************************************************************
301  * Seek: try to go at the right place
302  *****************************************************************************/
303 static int Seek( access_t *p_access, uint64_t i_pos )
304 {
305     access_sys_t *p_sys = p_access->p_sys;
306     int64_t      i_ret;
307
308     if( i_pos >= INT64_MAX )
309         return VLC_EGENERIC;
310
311     msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
312
313     i_ret = smbc_lseek( p_sys->i_smb, i_pos, SEEK_SET );
314     if( i_ret == -1 )
315     {
316         msg_Err( p_access, "seek failed (%s)", vlc_strerror_c(errno) );
317         return VLC_EGENERIC;
318     }
319
320     p_access->info.b_eof = false;
321
322     return VLC_SUCCESS;
323 }
324
325 /*****************************************************************************
326  * Read:
327  *****************************************************************************/
328 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
329 {
330     access_sys_t *p_sys = p_access->p_sys;
331     int i_read;
332
333     if( p_access->info.b_eof ) return 0;
334
335     i_read = smbc_read( p_sys->i_smb, p_buffer, i_len );
336     if( i_read < 0 )
337     {
338         msg_Err( p_access, "read failed (%s)", vlc_strerror_c(errno) );
339         p_access->info.b_eof = true;
340         return -1;
341     }
342
343     if( i_read == 0 ) p_access->info.b_eof = true;
344
345     return i_read;
346 }
347
348 #ifndef _WIN32
349 /*****************************************************************************
350  * DirRead:
351  *****************************************************************************/
352 static input_item_t* DirRead (access_t *p_access )
353 {
354     access_sys_t *p_sys = p_access->p_sys;
355     struct smbc_dirent *p_entry;
356     input_item_t *p_item = NULL;
357
358     while( !p_item && ( p_entry = smbc_readdir( p_sys->i_smb ) ) )
359     {
360         char *psz_uri;
361         const char *psz_location = p_access->psz_location;
362         const char *psz_name = p_entry->name;
363         int i_type;
364
365         switch( p_entry->smbc_type )
366         {
367         case SMBC_SERVER:
368         case SMBC_WORKGROUP:
369             psz_location = p_entry->name;
370             psz_name = NULL;
371         case SMBC_FILE_SHARE:
372         case SMBC_DIR:
373             i_type = ITEM_TYPE_DIRECTORY;
374             break;
375         case SMBC_FILE:
376             i_type = ITEM_TYPE_FILE;
377             break;
378         default:
379         case SMBC_PRINTER_SHARE:
380         case SMBC_COMMS_SHARE:
381         case SMBC_IPC_SHARE:
382         case SMBC_LINK:
383             continue;
384         }
385
386         if( smb_get_uri( p_access, &psz_uri, NULL, NULL, NULL,
387                          psz_location, psz_name ) < 0 )
388             return NULL;
389
390         p_item = input_item_NewWithTypeExt( psz_uri, p_entry->name, 0, NULL,
391                                             0, -1, i_type, 1 );
392         free( psz_uri );
393         if( !p_item )
394             return NULL;
395     }
396     return p_item;
397 }
398
399 static int DirControl( access_t *p_access, int i_query, va_list args )
400 {
401     switch( i_query )
402     {
403     case ACCESS_IS_DIRECTORY:
404         *va_arg( args, bool * ) = false; /* is not sorted */
405         *va_arg( args, bool * ) = true; /* might loop */
406         break;
407     default:
408         return access_vaDirectoryControlHelper( p_access, i_query, args );
409     }
410
411     return VLC_SUCCESS;
412 }
413 #endif
414
415 /*****************************************************************************
416  * Control:
417  *****************************************************************************/
418 static int Control( access_t *p_access, int i_query, va_list args )
419 {
420     switch( i_query )
421     {
422     case ACCESS_CAN_SEEK:
423     case ACCESS_CAN_FASTSEEK:
424     case ACCESS_CAN_PAUSE:
425     case ACCESS_CAN_CONTROL_PACE:
426         *va_arg( args, bool* ) = true;
427         break;
428
429     case ACCESS_GET_SIZE:
430         if( p_access->pf_readdir != NULL )
431             return VLC_EGENERIC;
432         *va_arg( args, uint64_t * ) = p_access->p_sys->size;
433         break;
434
435     case ACCESS_GET_PTS_DELAY:
436         *va_arg( args, int64_t * ) = INT64_C(1000)
437             * var_InheritInteger( p_access, "network-caching" );
438         break;
439
440     case ACCESS_SET_PAUSE_STATE:
441         /* Nothing to do */
442         break;
443
444     default:
445         return VLC_EGENERIC;
446     }
447
448     return VLC_SUCCESS;
449 }
450
451 #ifdef _WIN32
452 static void Win32AddConnection( access_t *p_access, char *psz_path,
453                                 char *psz_user, char *psz_pwd,
454                                 char *psz_domain )
455 {
456     char psz_remote[MAX_PATH], psz_server[MAX_PATH], psz_share[MAX_PATH];
457     NETRESOURCE net_resource;
458     DWORD i_result;
459     char *psz_parser;
460     VLC_UNUSED( psz_domain );
461
462     memset( &net_resource, 0, sizeof(net_resource) );
463     net_resource.dwType = RESOURCETYPE_DISK;
464
465     /* Find out server and share names */
466     strlcpy( psz_server, psz_path, sizeof( psz_server ) );
467     psz_share[0] = 0;
468     psz_parser = strchr( psz_path, '/' );
469     if( psz_parser )
470     {
471         char *psz_parser2 = strchr( ++psz_parser, '/' );
472         if( psz_parser2 )
473             strlcpy( psz_share, psz_parser, sizeof( psz_share ) );
474    }
475
476     snprintf( psz_remote, sizeof( psz_remote ), "\\\\%s\\%s", psz_server, psz_share );
477     net_resource.lpRemoteName = psz_remote;
478
479     i_result = WNetAddConnection2( &net_resource, psz_pwd, psz_user, 0 );
480
481     if( i_result != NO_ERROR )
482     {
483         msg_Dbg( p_access, "connected to %s", psz_remote );
484     }
485     else if( i_result != ERROR_ALREADY_ASSIGNED &&
486              i_result != ERROR_DEVICE_ALREADY_REMEMBERED )
487     {
488         msg_Dbg( p_access, "already connected to %s", psz_remote );
489     }
490     else
491     {
492         msg_Dbg( p_access, "failed to connect to %s", psz_remote );
493     }
494 }
495 #endif // _WIN32