09f6aed438fcb38629576ea096274bfed6d955bd
[vlc.git] / modules / access / smb.c
1 /*****************************************************************************
2  * smb.c: SMB input module
3  *****************************************************************************
4  * Copyright (C) 2001-2009 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_common.h>
34 #include <vlc_charset.h>
35 #include <vlc_plugin.h>
36 #include <vlc_access.h>
37
38 #ifdef WIN32
39 #   ifdef HAVE_FCNTL_H
40 #       include <fcntl.h>
41 #   endif
42 #   ifdef HAVE_SYS_STAT_H
43 #       include <sys/stat.h>
44 #   endif
45 #   include <io.h>
46 #   define smbc_open(a,b,c) utf8_open(a,b,c)
47 #   define stat _stati64
48 #   define smbc_fstat(a,b) _fstati64(a,b)
49 #   define smbc_read read
50 #   define smbc_lseek _lseeki64
51 #   define smbc_close close
52 #else
53 #   include <libsmbclient.h>
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         change_safe()
87     add_string( "smb-user", NULL, NULL, USER_TEXT, USER_LONGTEXT,
88                 false )
89     add_password( "smb-pwd", NULL, NULL, PASS_TEXT,
90                   PASS_LONGTEXT, false )
91     add_string( "smb-domain", NULL, NULL, DOMAIN_TEXT,
92                 DOMAIN_LONGTEXT, false )
93     add_shortcut( "smb" )
94     set_callbacks( Open, Close )
95 vlc_module_end ()
96
97 /*****************************************************************************
98  * Local prototypes
99  *****************************************************************************/
100 static ssize_t Read( access_t *, uint8_t *, size_t );
101 static int Seek( access_t *, int64_t );
102 static int Control( access_t *, int, va_list );
103
104 struct access_sys_t
105 {
106     int i_smb;
107 };
108
109 #ifdef WIN32
110 static void Win32AddConnection( access_t *, char *, char *, char *, char * );
111 #else
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 #endif
118
119 /****************************************************************************
120  * Open: connect to smb server and ask for file
121  ****************************************************************************/
122 static int Open( vlc_object_t *p_this )
123 {
124     access_t     *p_access = (access_t*)p_this;
125     access_sys_t *p_sys;
126     struct stat  filestat;
127     char         *psz_path, *psz_uri;
128     char         *psz_user = NULL, *psz_pwd = NULL, *psz_domain = NULL;
129     int          i_ret;
130     int          i_smb;
131
132     /* Parse input URI
133      * [[[domain;]user[:password@]]server[/share[/path[/file]]]] */
134     psz_path = strchr( p_access->psz_path, '/' );
135     if( !psz_path )
136     {
137         msg_Err( p_access, "invalid SMB URI: smb://%s", psz_path );
138         return VLC_EGENERIC;
139     }
140     else
141     {
142         char *psz_tmp = strdup( p_access->psz_path );
143         char *psz_parser;
144
145         psz_tmp[ psz_path - p_access->psz_path ] = 0;
146         psz_path = p_access->psz_path;
147         psz_parser = strchr( psz_tmp, '@' );
148         if( psz_parser )
149         {
150             /* User info is there */
151             *psz_parser = 0;
152             psz_path = p_access->psz_path + (psz_parser - psz_tmp) + 1;
153
154             psz_parser = strchr( psz_tmp, ':' );
155             if( psz_parser )
156             {
157                 /* Password found */
158                 psz_pwd = strdup( psz_parser+1 );
159                 *psz_parser = 0;
160             }
161
162             psz_parser = strchr( psz_tmp, ';' );
163             if( psz_parser )
164             {
165                 /* Domain found */
166                 *psz_parser = 0; psz_parser++;
167                 psz_domain = strdup( psz_tmp );
168             }
169             else psz_parser = psz_tmp;
170
171             psz_user = strdup( psz_parser );
172         }
173
174         free( psz_tmp );
175     }
176
177     /* Build an SMB URI
178      * smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]] */
179
180     if( !psz_user ) psz_user = var_CreateGetString( p_access, "smb-user" );
181     if( psz_user && !*psz_user ) { free( psz_user ); psz_user = NULL; }
182     if( !psz_pwd ) psz_pwd = var_CreateGetString( p_access, "smb-pwd" );
183     if( psz_pwd && !*psz_pwd ) { free( psz_pwd ); psz_pwd = NULL; }
184     if( !psz_domain ) psz_domain = var_CreateGetString( p_access, "smb-domain" );
185     if( psz_domain && !*psz_domain ) { free( psz_domain ); psz_domain = NULL; }
186
187 #ifdef WIN32
188     if( psz_user )
189         Win32AddConnection( p_access, psz_path, psz_user, psz_pwd, psz_domain);
190     i_ret = asprintf( &psz_uri, "//%s", psz_path );
191 #else
192     if( psz_user )
193         i_ret = asprintf( &psz_uri, "smb://%s%s%s%s%s@%s",
194                           psz_domain ? psz_domain : "", psz_domain ? ";" : "",
195                           psz_user, psz_pwd ? ":" : "",
196                           psz_pwd ? psz_pwd : "", psz_path );
197     else
198         i_ret = asprintf( &psz_uri, "smb://%s", psz_path );
199 #endif
200
201     free( psz_user );
202     free( psz_pwd );
203     free( psz_domain );
204
205     if( i_ret == -1 )
206         return VLC_ENOMEM;
207
208 #ifndef WIN32
209     if( smbc_init( smb_auth, 0 ) )
210     {
211         free( psz_uri );
212         return VLC_EGENERIC;
213     }
214 #endif
215
216 /*
217 ** some version of glibc defines open as a macro, causing havoc
218 ** with other macros using 'open' under the hood, such as the
219 ** following one:
220 */
221 #if defined(smbc_open) && defined(open)
222 # undef open
223 #endif
224     if( (i_smb = smbc_open( psz_uri, O_RDONLY, 0 )) < 0 )
225     {
226         msg_Err( p_access, "open failed for '%s' (%m)", p_access->psz_path );
227         free( psz_uri );
228         return VLC_EGENERIC;
229     }
230
231     /* Init p_access */
232     STANDARD_READ_ACCESS_INIT;
233
234     i_ret = smbc_fstat( i_smb, &filestat );
235     if( i_ret )
236     {
237         errno = i_ret;
238         msg_Err( p_access, "stat failed (%m)" );
239     }
240     else
241         p_access->info.i_size = filestat.st_size;
242
243     free( psz_uri );
244
245     p_sys->i_smb = i_smb;
246
247     /* Update default_pts to a suitable value for smb access */
248     var_Create( p_access, "smb-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
249
250     return VLC_SUCCESS;
251 }
252
253 /*****************************************************************************
254  * Close: free unused data structures
255  *****************************************************************************/
256 static void Close( vlc_object_t *p_this )
257 {
258     access_t     *p_access = (access_t*)p_this;
259     access_sys_t *p_sys = p_access->p_sys;
260
261     smbc_close( p_sys->i_smb );
262     free( p_sys );
263 }
264
265 /*****************************************************************************
266  * Seek: try to go at the right place
267  *****************************************************************************/
268 static int Seek( access_t *p_access, int64_t i_pos )
269 {
270     access_sys_t *p_sys = p_access->p_sys;
271     int64_t      i_ret;
272
273     if( i_pos < 0 ) return VLC_EGENERIC;
274
275     msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
276
277     i_ret = smbc_lseek( p_sys->i_smb, i_pos, SEEK_SET );
278     if( i_ret == -1 )
279     {
280         msg_Err( p_access, "seek failed (%m)" );
281         return VLC_EGENERIC;
282     }
283
284     p_access->info.b_eof = false;
285     p_access->info.i_pos = i_ret;
286
287     return VLC_SUCCESS;
288 }
289
290 /*****************************************************************************
291  * Read:
292  *****************************************************************************/
293 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
294 {
295     access_sys_t *p_sys = p_access->p_sys;
296     int i_read;
297
298     if( p_access->info.b_eof ) return 0;
299
300     i_read = smbc_read( p_sys->i_smb, p_buffer, i_len );
301     if( i_read < 0 )
302     {
303         msg_Err( p_access, "read failed (%m)" );
304         return -1;
305     }
306
307     if( i_read == 0 ) p_access->info.b_eof = true;
308     else if( i_read > 0 ) p_access->info.i_pos += i_read;
309
310     return i_read;
311 }
312
313 /*****************************************************************************
314  * Control:
315  *****************************************************************************/
316 static int Control( access_t *p_access, int i_query, va_list args )
317 {
318     bool        *pb_bool;
319     int64_t     *pi_64;
320
321     switch( i_query )
322     {
323     case ACCESS_CAN_SEEK:
324     case ACCESS_CAN_FASTSEEK:
325     case ACCESS_CAN_PAUSE:
326     case ACCESS_CAN_CONTROL_PACE:
327         pb_bool = (bool*)va_arg( args, bool* );
328         *pb_bool = true;
329         break;
330
331     case ACCESS_GET_PTS_DELAY:
332         pi_64 = (int64_t*)va_arg( args, int64_t * );
333         *pi_64 = (int64_t)var_GetInteger( p_access, "smb-caching" ) * 1000;
334         break;
335
336     case ACCESS_SET_PAUSE_STATE:
337         /* Nothing to do */
338         break;
339
340     case ACCESS_GET_TITLE_INFO:
341     case ACCESS_SET_TITLE:
342     case ACCESS_SET_SEEKPOINT:
343     case ACCESS_SET_PRIVATE_ID_STATE:
344     case ACCESS_GET_CONTENT_TYPE:
345         return VLC_EGENERIC;
346
347     default:
348         msg_Warn( p_access, "unimplemented query in control" );
349         return VLC_EGENERIC;
350
351     }
352
353     return VLC_SUCCESS;
354 }
355
356 #ifdef WIN32
357 static void Win32AddConnection( access_t *p_access, char *psz_path,
358                                 char *psz_user, char *psz_pwd,
359                                 char *psz_domain )
360 {
361     DWORD (*OurWNetAddConnection2)( LPNETRESOURCE, LPCTSTR, LPCTSTR, DWORD );
362     char psz_remote[MAX_PATH], psz_server[MAX_PATH], psz_share[MAX_PATH];
363     NETRESOURCE net_resource;
364     DWORD i_result;
365     char *psz_parser;
366     VLC_UNUSED( psz_domain );
367
368     HINSTANCE hdll = LoadLibrary(_T("MPR.DLL"));
369     if( !hdll )
370     {
371         msg_Warn( p_access, "couldn't load mpr.dll" );
372         return;
373     }
374
375     OurWNetAddConnection2 =
376       (void *)GetProcAddress( hdll, _T("WNetAddConnection2A") );
377     if( !OurWNetAddConnection2 )
378     {
379         msg_Warn( p_access, "couldn't find WNetAddConnection2 in mpr.dll" );
380         return;
381     }
382
383     memset( &net_resource, 0, sizeof(net_resource) );
384     net_resource.dwType = RESOURCETYPE_DISK;
385
386     /* Find out server and share names */
387     strlcpy( psz_server, psz_path, sizeof( psz_server ) );
388     psz_share[0] = 0;
389     psz_parser = strchr( psz_path, '/' );
390     if( psz_parser )
391     {
392         char *psz_parser2 = strchr( ++psz_parser, '/' );
393         if( psz_parser2 )
394             strlcpy( psz_share, psz_parser, sizeof( psz_share ) );
395    }
396
397     snprintf( psz_remote, sizeof( psz_remote ), "\\\\%s\\%s", psz_server, psz_share );
398     net_resource.lpRemoteName = psz_remote;
399
400     i_result = OurWNetAddConnection2( &net_resource, psz_pwd, psz_user, 0 );
401
402     if( i_result != NO_ERROR )
403     {
404         msg_Dbg( p_access, "connected to %s", psz_remote );
405     }
406     else if( i_result != ERROR_ALREADY_ASSIGNED &&
407              i_result != ERROR_DEVICE_ALREADY_REMEMBERED )
408     {
409         msg_Dbg( p_access, "already connected to %s", psz_remote );
410     }
411     else
412     {
413         msg_Dbg( p_access, "failed to connect to %s", psz_remote );
414     }
415
416     FreeLibrary( hdll );
417 }
418 #endif // WIN32