rUtilAnts 0.1.0.20091014

data/lib/rUtilAnts/URLHandlers/HTTP.rb

@@ -0,0 +1,126 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RUtilAnts
+
+  module URLCache
+
+    module URLHandlers
+
+      # Handler of HTTP URLs
+      class HTTP
+
+        # Get a list of regexps matching the URL to get to this handler
+        #
+        # Return:
+        # * <em>list<Regexp></em>: The list of regexps matching URLs from this handler
+        def self.getMatchingRegexps
+          return [
+            /^(http|https):\/\/.*$/
+          ]
+        end
+
+        # Constructor
+        #
+        # Parameters:
+        # * *iURL* (_String_): The URL that this handler will manage
+        def initialize(iURL)
+          @URL = iURL
+          lURLMatch = iURL.match(/^(http|https):\/\/([^\/]*)\/(.*)$/)
+          if (lURLMatch == nil)
+            lURLMatch = iURL.match(/^(http|https):\/\/(.*)$/)
+          end
+          if (lURLMatch == nil)
+            logBug "URL #{iURL} was identified as an http like, but it appears to be false."
+          else
+            @URLProtocol, @URLServer, @URLPath = lURLMatch[1..3]
+          end
+        end
+
+        # Get the server ID
+        #
+        # Return:
+        # * _String_: The server ID
+        def getServerID
+          return "#{@URLProtocol}://#{@URLServer}"
+        end
+
+        # Get the current CRC of the URL
+        #
+        # Return:
+        # * _Integer_: The CRC
+        def getCRC
+          # We consider HTTP URLs to be definitive: CRCs will never change.
+          return 0
+        end
+
+        # Get a corresponding file base name.
+        # This method has to make sure file extensions are respected, as it can be used for further processing.
+        #
+        # Return:
+        # * _String_: The file name
+        def getCorrespondingFileBaseName
+          # Check that extension has no characters following the URL (#, ? and ;)
+          return getValidFileName(File.basename(@URLPath.gsub(/^([^#\?;]*).*$/,'\1')))
+        end
+
+        # Get the content of the URL
+        #
+        # Parameters:
+        # * *iFollowRedirections* (_Boolean_): Do we follow redirections while accessing the content ?
+        # Return:
+        # * _Integer_: Type of content returned
+        # * _Object_: The content, depending on the type previously returned:
+        # ** _Exception_ if CONTENT_ERROR: The corresponding error
+        # ** _String_ if CONTENT_REDIRECT: The new URL
+        # ** _String_ if CONTENT_STRING: The real content
+        # ** _String_ if CONTENT_LOCALFILENAME: The name of the local file name storing the content
+        # ** _String_ if CONTENT_LOCALFILENAME_TEMPORARY: The name of the temporary local file name storing the content
+        def getContent(iFollowRedirections)
+          rContentFormat = nil
+          rContent = nil
+
+          begin
+            require 'net/http'
+            Net::HTTP.start(@URLServer) do |iHTTPConnection|
+              lResponse = iHTTPConnection.get("/#{@URLPath}")
+              if ((iFollowRedirections) and
+                  (lResponse.is_a?(Net::HTTPRedirection)))
+                # We access the file through a new URL
+                rContent = lResponse['location']
+                lNewURLMatch = rContent.match(/^(ftp|ftps|http|https):\/\/(.*)$/)
+                if (lNewURLMatch == nil)
+                  if (rContent[0..0] == '/')
+                    rContent = "#{@URLProtocol}://#{@URLServer}#{rContent}"
+                  else
+                    rContent = "#{@URLProtocol}://#{@URLServer}/#{File.dirname(@URLPath)}/#{rContent}"
+                  end
+                end
+                rContentFormat = CONTENT_REDIRECT
+              elsif (lResponse.is_a?(Net::HTTPOK))
+                # We have the web page
+                rContent = lResponse.body
+                rContentFormat = CONTENT_STRING
+              else
+                # An error occurred
+                rContent = RuntimeError.new("Access error to #{@URL}: #{lResponse.code}.")
+                rContentFormat = CONTENT_ERROR
+              end
+            end
+          rescue Exception
+            rContent = $!
+            rContentFormat = CONTENT_ERROR
+          end
+
+          return rContentFormat, rContent
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/rUtilAnts/URLHandlers/LocalFile.rb

@@ -0,0 +1,100 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RUtilAnts
+
+  module URLCache
+
+    module URLHandlers
+
+      # Handler of file URLs
+      class LocalFile
+
+        # Get a list of regexps matching the URL to get to this handler
+        #
+        # Return:
+        # * <em>list<Regexp></em>: The list of regexps matching URLs from this handler
+        def self.getMatchingRegexps
+          return [
+            /^file:\/\/\/(.*)$/
+          ]
+        end
+
+        # Constructor
+        #
+        # Parameters:
+        # * *iURL* (_String_): The URL that this handler will manage
+        def initialize(iURL)
+          @URL = iURL
+          lURLMatch = iURL.match(/^file:\/\/([^\/]*)\/(.*)$/)
+          if (lURLMatch != nil)
+            @URL = lURLMatch[1]
+          end
+        end
+
+        # Get the server ID
+        #
+        # Return:
+        # * _String_: The server ID
+        def getServerID
+          return nil
+        end
+
+        # Get the current CRC of the URL
+        #
+        # Return:
+        # * _Integer_: The CRC
+        def getCRC
+          # We consider the file's modification time
+          if (File.exists?(@URL))
+            return File.mtime(@URL)
+          else
+            return 0
+          end
+        end
+
+        # Get a corresponding file base name.
+        # This method has to make sure file extensions are respected, as it can be used for further processing.
+        #
+        # Return:
+        # * _String_: The file name
+        def getCorrespondingFileBaseName
+          return File.basename(@URL)
+        end
+
+        # Get the content of the URL
+        #
+        # Parameters:
+        # * *iFollowRedirections* (_Boolean_): Do we follow redirections while accessing the content ?
+        # Return:
+        # * _Integer_: Type of content returned
+        # * _Object_: The content, depending on the type previously returned:
+        # ** _Exception_ if CONTENT_ERROR: The corresponding error
+        # ** _String_ if CONTENT_REDIRECT: The new URL
+        # ** _String_ if CONTENT_STRING: The real content
+        # ** _String_ if CONTENT_LOCALFILENAME: The name of the local file name storing the content
+        # ** _String_ if CONTENT_LOCALFILENAME_TEMPORARY: The name of the temporary local file name storing the content
+        def getContent(iFollowRedirections)
+          rContentFormat = nil
+          rContent = nil
+
+          if (File.exists?(@URL))
+            rContent = @URL
+            rContentFormat = CONTENT_LOCALFILENAME
+          else
+            rContent = Errno::ENOENT.new(@URL)
+            rContentFormat = CONTENT_ERROR
+          end
+
+          return rContentFormat, rContent
+        end
+
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: rUtilAnts
+version: !ruby/object:Gem::Version 
+  version: 0.1.0.20091014
+platform: ruby
+authors: 
+- Muriel Salvan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: rUtilAnts is used by several projects. It includes common standard code.
+email: murielsalvan@users.sourceforge.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- TODO
+- ChangeLog
+- LICENSE
+- AUTHORS
+- Credits
+files: 
+- lib/rUtilAnts/Plugins.rb
+- lib/rUtilAnts/GUI.rb
+- lib/rUtilAnts/Platform.rb
+- lib/rUtilAnts/URLAccess.rb
+- lib/rUtilAnts/Logging.rb
+- lib/rUtilAnts/URLCache.rb
+- lib/rUtilAnts/Misc.rb
+- lib/rUtilAnts/URLHandlers/HTTP.rb
+- lib/rUtilAnts/URLHandlers/FTP.rb
+- lib/rUtilAnts/URLHandlers/LocalFile.rb
+- lib/rUtilAnts/URLHandlers/DataImage.rb
+- lib/rUtilAnts/GUI/Bug.png
+- lib/rUtilAnts/GUI/BugReportDialog.rb
+- lib/rUtilAnts/Platforms/i386-linux/PlatformInfo.rb
+- lib/rUtilAnts/Platforms/i386-mswin32/PlatformInfo.rb
+- README
+- TODO
+- ChangeLog
+- LICENSE
+- AUTHORS
+- Credits
+has_rdoc: true
+homepage: http://rutilants.sourceforge.net/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rutilants
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: A collection of various utility libraries.
+test_files: []
+