mupnp 0.1

data/README

@@ -0,0 +1,13 @@
+= UPnP
+
+The gem is based on the work of Thomas Bernard, miniupnp library
+(http://miniupnp.free.fr/). The source code and his license can be
+found in the ext directory.
+The windows version will be made as long as
+i have some volounteer that can provide me the precompiled code for
+windows. The library is in the module called MiniUPnP, in it you can
+find all the library functions.
+The module UPnP is a wrapper that simplify the access to the
+underlaying library.
+The interface was automatically built with swig (http://www.swig.org/),
+the interface file is upnp.i

data/Rakefile

@@ -0,0 +1,80 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+
+spec = Gem::Specification.new do |s|
+    s.name     = "mupnp"
+    s.version  = "0.1"
+    s.author   = "Dario Meloni"
+    s.email    = "mellon85@gmail.com"
+    s.homepage = "http://rubyforge.org/projects/mupnp/"
+    s.rubyforge_project = "mupnp"
+    s.summary  = "UPnP Implementation using the Miniupnpc library"
+    s.files    = FileList['lib/**/*.rb', 'test/**/*.rb', 'Rakefile',
+                           'ext/*.[chi]'].to_a
+    s.extra_rdoc_files = FileList['README','ext/README','ext/LICENSE','ext/Changelog.txt'].to_a
+    s.require_path = ["lib", "ext"]
+    s.test_files = Dir.glob('test/**/tc_*.rb')
+    s.has_rdoc  = true
+    s.extensions << "ext/extconf.rb"
+    s.require_path = 'lib'
+
+    if RUBY_PLATFORM =~ /mswin/
+      s.files += ["ext/miniupnp.so"]
+      s.extensions.clear
+      s.platform = Gem::Platform::WIN32
+    end
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.gem_spec = spec
+    unless RUBY_PLATFORM =~ /mswin/
+        p.need_tar = true
+        p.need_zip = true
+    end
+end
+
+Rake::RDocTask.new do |rd|
+    rd.rdoc_dir = "rdoc"
+    rd.rdoc_files.include("./lib/**/*.rb")
+    rd.rdoc_files.include("README")
+    rd.options = %w(-ap)
+end
+
+task :distclean => [:clobber_package, :clobber_rdoc]
+task :dist      => [:repackage, :gem, :rdoc]
+task :clean     => [:distclean, :extclean]
+task :default   => [:test, :dist ]
+
+desc "Build the extension"
+task :ext => ["ext/Makefile"] do
+    cd "ext"
+    if (/mswin/ =~ RUBY_PLATFORM) and ENV['make'].nil?
+        begin
+            sh "nmake"
+        rescue Exception => e
+            puts "Windows builds is absolutely experimental... all on your back"
+            raise e
+        end
+    else
+        sh "make"
+    end
+    cd ".."
+end
+
+desc "Build makefile"
+file "ext/Makefile" do
+  cd "ext"
+  `ruby extconf.rb`
+  cd ".."
+end
+
+desc "Clean extension"
+task :extclean do
+    cd 'ext'
+    rm_f FileList["*.o","*.so","*.bundle","*.dll","Makefile"]
+    cd '..'
+end

data/ext/Changelog.txt

@@ -0,0 +1,188 @@
+$Id: Changelog.txt,v 1.60 2008/02/21 13:05:27 nanard Exp $
+miniUPnP client Changelog.
+
+2008/02/21:
+  put some #ifdef DEBUG around DisplayNameValueList()
+
+2008/02/18:
+  Improved error reporting in upnpcommands.c
+  UPNP_GetStatusInfo() returns LastConnectionError
+
+2008/02/16:
+  better error handling in minisoap.c
+  improving display of "valid IGD found" in upnpc.c
+
+2008/02/03:
+  Fixing UPNP_GetValidIGD()
+  improved make install :)
+
+2007/12/22:
+  Adding upnperrors.c/h to provide a strupnperror() function 
+  used to translate UPnP error codes to string.
+
+2007/12/19:
+  Fixing getDevicesFromMiniSSDPD()
+  improved error reporting of UPnP functions
+
+2007/12/18:
+  It is now possible to specify a different location for MiniSSDPd socket.
+  working with MiniSSDPd is now more efficient.
+  python module improved.
+
+2007/12/16:
+  improving error reporting
+
+2007/12/13:
+  Try to improve compatibility by using HTTP/1.0 instead of 1.1 and
+  XML a bit different for SOAP.
+
+2007/11/25:
+  fixed select() call for linux
+
+2007/11/15:
+  Added -fPIC to CFLAG for better shared library code.
+
+2007/11/02:
+  Fixed a potential socket leak in miniwget2()
+
+2007/10/16:
+  added a parameter to upnpDiscover() in order to allow the use of another
+  interface than the default multicast interface.
+
+2007/10/12:
+  Fixed the creation of symbolic link in Makefile
+
+2007/10/08:
+  Added man page
+
+2007/10/02:
+  fixed memory bug in GetUPNPUrls()
+
+2007/10/01:
+  fixes in the Makefile
+  Added UPNP_GetIGDFromUrl() and adapted the sample program accordingly.
+  Added SONAME in the shared library to please debian :)
+  fixed MS Windows compilation (minissdpd is not available under MS Windows).
+
+2007/09/25:
+  small change to Makefile to be able to install in a different location
+  (default is /usr)
+
+2007/09/24:
+  now compiling both shared and static library
+
+2007/09/19:
+  Cosmetic changes on upnpc.c
+
+2007/09/02:
+  adapting to new miniSSDPd (release version ?)
+
+2007/08/31:
+  Usage of miniSSDPd to skip discovery process.
+
+2007/08/27:
+  fixed python module to allow compilation with Python older than Python 2.4
+
+2007/06/12:
+  Added a python module.
+
+2007/05/19:
+  Fixed compilation under MinGW
+
+2007/05/15:
+  fixed a memory leak in AddPortMapping()
+  Added testupnpreplyparse executable to check the parsing of
+  upnp soap messages
+  minixml now ignore namespace prefixes.
+
+2007/04/26:
+  upnpc now displays external ip address with -s or -l
+
+2007/04/11:
+  changed MINIUPNPC_URL_MAXSIZE to 128 to accomodate the "BT Voyager 210"
+
+2007/03/19:
+  cleanup in miniwget.c
+
+2007/03/01:
+  Small typo fix...
+
+2007/01/30:
+  Now parsing the HTTP header from SOAP responses in order to
+  get content-length value.
+
+2007/01/29:
+  Fixed the Soap Query to speedup the HTTP request.
+  added some Win32 DLL stuff...
+
+2007/01/27:
+  Fixed some WIN32 compatibility issues
+
+2006/12/14:
+  Added UPNPIGD_IsConnected() function in miniupnp.c/.h
+  Added UPNP_GetValidIGD() in miniupnp.c/.h
+  cleaned upnpc.c main(). now using UPNP_GetValidIGD()
+
+2006/12/07:
+  Version 1.0-RC1 released
+
+2006/12/03:
+  Minor changes to compile under SunOS/Solaris
+
+2006/11/30:
+  made a minixml parser validator program
+  updated minixml to handle attributes correctly
+
+2006/11/22:
+  Added a -r option to the upnpc sample thanks to Alexander Hubmann.
+
+2006/11/19:
+  Cleanup code to make it more ANSI C compliant
+
+2006/11/10:
+  detect and display local lan address.
+
+2006/11/04:
+  Packets and Bytes Sent/Received are now unsigned int.
+
+2006/11/01:
+  Bug fix thanks to Giuseppe D'Angelo
+
+2006/10/31:
+  C++ compatibility for .h files.
+  Added a way to get ip Address on the LAN used to reach the IGD.
+
+2006/10/25:
+  Added M-SEARCH to the services in the discovery process.
+
+2006/10/22:
+  updated the Makefile to use makedepend, added a "make install"
+  update Makefile
+
+2006/10/20:
+  fixing the description url parsing thanks to patch sent by
+  Wayne Dawe.
+  Fixed/translated some comments.
+  Implemented a better discover process, first looking
+  for IGD then for root devices (as some devices only reply to
+  M-SEARCH for root devices).
+
+2006/09/02:
+  added freeUPNPDevlist() function.
+
+2006/08/04:
+  More command line arguments checking
+
+2006/08/01:
+  Added the .bat file to compile under Win32 with minGW32
+
+2006/07/31:
+  Fixed the rootdesc parser (igd_desc_parse.c)
+
+2006/07/20:
+  parseMSEARCHReply() is now returning the ST: line as well
+  starting changes to detect several UPnP devices on the network
+
+2006/07/19:
+  using GetCommonLinkProperties to get down/upload bitrate
+

data/ext/LICENSE

@@ -0,0 +1,27 @@
+
+Copyright (c) 2005-2007, Thomas BERNARD 
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+

data/ext/README

@@ -0,0 +1,53 @@
+
+Project: miniupnp
+Project web page: http://miniupnp.free.fr/
+Author: Thomas Bernard
+Copyright (c) 2005-2007 Thomas Bernard
+This software is subject to the conditions detailed in the
+LICENCE file provided within this distribution.
+
+For the comfort of Win32 users, bsdqueue.h is included in the distribution.
+Its licence is included in the header of the file.
+bsdqueue.h is a copy of the sys/queue.h of an OpenBSD system.
+
+* miniupnp Client *
+
+To compile, simply run 'gmake' (could be 'make').
+Under win32, to compile with MinGW, type "mingw32make.bat".
+The compilation is known to work under linux, FreeBSD,
+OpenBSD, MacOS X and cygwin.
+To install the library and headers on the system use :
+> su
+> make install
+> exit
+
+alternatively, to install in a specific location, use :
+> INSTALLPREFIX=/usr/local make install
+
+upnpc.c is a sample client using the libminiupnpc.
+To use the libminiupnpc in your application, link it with
+libminiupnpc.a and use the following functions found in miniupnpc.h,
+upnpcommands.h and miniwget.h :
+- upnpDiscover()
+- miniwget()
+- parserootdesc()
+- GetUPNPUrls()
+- UPNP_* (calling UPNP methods)
+
+Note : use #include <miniupnpc/miniupnpc.h> etc... for the includes
+and -lminiupnpc for the link
+
+* Python module *
+
+you can build a python module with 'make pythonmodule' 
+and install it with 'make installpythonmodule'.
+setup.py (and setpmingw32.py) are included in the distribution.
+
+
+Feel free to contact me if you have any problem :
+e-mail : miniupnp@free.fr
+
+If you are using libminiupnpc in your application, please
+send me an email !
+
+

data/ext/declspec.h

@@ -0,0 +1,15 @@
+#ifndef __DECLSPEC_H__
+#define __DECLSPEC_H__
+
+#if defined(WIN32) && !defined(STATICLIB)
+	#ifdef MINIUPNP_EXPORTS
+		#define LIBSPEC __declspec(dllexport)
+	#else
+		#define LIBSPEC __declspec(dllimport)
+	#endif
+#else
+	#define LIBSPEC
+#endif
+
+#endif
+

data/ext/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+$CFLAGS = '-DNDEBUG'
+create_makefile("MiniUPnP")
+

data/ext/igd_desc_parse.c

@@ -0,0 +1,115 @@
+/* $Id: igd_desc_parse.c,v 1.7 2006/11/19 22:32:33 nanard Exp $ */
+/* Project : miniupnp
+ * http://miniupnp.free.fr/
+ * Author : Thomas Bernard
+ * Copyright (c) 2005 Thomas Bernard
+ * This software is subject to the conditions detailed in the
+ * LICENCE file provided in this distribution.
+ * */
+#include "igd_desc_parse.h"
+#include <stdio.h>
+#include <string.h>
+
+/* Start element handler :
+ * update nesting level counter and copy element name */
+void IGDstartelt(void * d, const char * name, int l)
+{
+	struct IGDdatas * datas = (struct IGDdatas *)d;
+	memcpy( datas->cureltname, name, l);
+	datas->cureltname[l] = '\0';
+	datas->level++;
+}
+
+/* End element handler :
+ * update nesting level counter and update parser state if
+ * service element is parsed */
+void IGDendelt(void * d, const char * name, int l)
+{
+	struct IGDdatas * datas = (struct IGDdatas *)d;
+	datas->level--;
+	/*printf("endelt %2d %.*s\n", datas->level, l, name);*/
+	if( (l==7) && !memcmp(name, "service", l) )
+	{
+		/*datas->state++; */
+		/*
+		if( datas->state < 1
+			&& !strcmp(datas->servicetype,
+				//	"urn:schemas-upnp-org:service:WANIPConnection:1") )
+				"urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1"))
+			datas->state ++;
+		*/
+		if(0==strcmp(datas->servicetype_CIF,
+				"urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1"))
+			datas->state = 2;
+		if(0==strcmp(datas->servicetype,
+				"urn:schemas-upnp-org:service:WANIPConnection:1") )
+			datas->state = 3;
+/*		if(0==strcmp(datas->servicetype,
+				"urn:schemas-upnp-org:service:WANPPPConnection:1") )
+			datas->state = 4; */
+	}
+}
+
+/* Data handler :
+ * copy data depending on the current element name and state */
+void IGDdata(void * d, const char * data, int l)
+{
+	struct IGDdatas * datas = (struct IGDdatas *)d;
+	char * dstmember = 0;
+	/*printf("%2d %s : %.*s\n",
+           datas->level, datas->cureltname, l, data);	*/
+	if( !strcmp(datas->cureltname, "URLBase") )
+		dstmember = datas->urlbase;
+	else if(datas->state<=1)
+	{
+		if( !strcmp(datas->cureltname, "serviceType") )
+			dstmember = datas->servicetype_CIF;
+		else if( !strcmp(datas->cureltname, "controlURL") )
+			dstmember = datas->controlurl_CIF;
+		else if( !strcmp(datas->cureltname, "eventSubURL") )
+			dstmember = datas->eventsuburl_CIF;
+		else if( !strcmp(datas->cureltname, "SCPDURL") )
+			dstmember = datas->scpdurl_CIF;
+		else if( !strcmp(datas->cureltname, "deviceType") )
+			dstmember = datas->devicetype_CIF;
+	}
+	else if(datas->state==2)
+	{
+		if( !strcmp(datas->cureltname, "serviceType") )
+			dstmember = datas->servicetype;
+		else if( !strcmp(datas->cureltname, "controlURL") )
+			dstmember = datas->controlurl;
+		else if( !strcmp(datas->cureltname, "eventSubURL") )
+			dstmember = datas->eventsuburl;
+		else if( !strcmp(datas->cureltname, "SCPDURL") )
+			dstmember = datas->scpdurl;
+		else if( !strcmp(datas->cureltname, "deviceType") )
+			dstmember = datas->devicetype;
+	}
+	if(dstmember)
+	{
+		if(l>=MINIUPNPC_URL_MAXSIZE)
+			l = MINIUPNPC_URL_MAXSIZE-1;
+		memcpy(dstmember, data, l);
+		dstmember[l] = '\0';
+	}
+}
+
+void printIGD(struct IGDdatas * d)
+{
+	printf("urlbase = %s\n", d->urlbase);
+	printf("WAN Device (Common interface config) :\n");
+	printf(" deviceType = %s\n", d->devicetype_CIF);
+	printf(" serviceType = %s\n", d->servicetype_CIF);
+	printf(" controlURL = %s\n", d->controlurl_CIF);
+	printf(" eventSubURL = %s\n", d->eventsuburl_CIF);
+	printf(" SCPDURL = %s\n", d->scpdurl_CIF);
+	printf("WAN Connection Device :\n");
+	printf(" deviceType = %s\n", d->devicetype);
+	printf(" servicetype = %s\n", d->servicetype);
+	printf(" controlURL = %s\n", d->controlurl);
+	printf(" eventSubURL = %s\n", d->eventsuburl);
+	printf(" SCPDURL = %s\n", d->scpdurl);
+}
+
+