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