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