Class: Rfm::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/rfm/server.rb

Overview

The Database object represents a single FileMaker Pro database. When you retrieve a Database object from a server, its account name and password are set to the account name and password you used when initializing the Server object. You can override this of course:

myDatabase = myServer["Customers"]
myDatabase. = "foo"
myDatabase.password = "bar"

Accessing Layouts

All interaction with FileMaker happens through a Layout object. You can get a Layout object from the Database object like this:

myLayout = myDatabase["Details"]

This code gets the Layout object representing the layout called Details in the database.

Note: RFM does not talk to the server when you retrieve a Layout object in this way. Instead, it simply assumes you know what you’re talking about. If the layout you specify does not exist, you will get no error at this point. Instead, you’ll get an error when you use the Layout object methods to talk to FileMaker. This makes debugging a little less convenient, but it would introduce too much overhead to hit the server at this point.

The Database object has a layout attribute that provides alternate access to Layout objects. It acts like a hash of Layout objects, one for each accessible layout in the database. So, for example, you can do this if you want to print out a list of all layouts:

myDatabase.layout.each {|layout|
  puts layout.name
}

The Database::layout attribute is actually a LayoutFactory object, although it subclasses hash, so it should work in all the ways you expect. Note, though, that it is completely empty until the first time you attempt to access its elements. At that (lazy) point, it hits FileMaker, loads in the list of layouts, and constructs a Layout object for each one. In other words, it incurrs no overhead until you use it.

Accessing Scripts

If for some reason you need to enumerate the scripts in a database, you can do so:

myDatabase.script.each {|script|
  puts script.name
}

The Database::script attribute is actually a ScriptFactory object, although it subclasses hash, so it should work in all the ways you expect. Note, though, that it is completely empty until the first time you attempt to access its elements. At that (lazy) point, it hits FileMaker, loads in the list of scripts, and constructs a Script object for each one. In other words, it incurrs no overhead until you use it.

Note: You don’t need a Script object to run a script (see the Layout object instead).

Attributes

In addition to the layout attribute, Server has a few other useful attributes:

  • server is the Server object this database comes from

  • name is the name of this database

  • state is a hash of all server options used to initialize this server

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Server

To create a Server object, you typically need at least a host name:

myServer = Rfm::Server.new({:host => 'my.host.com'})

Several other options are supported:

  • host the hostname of the Web Publishing Engine (WPE) server (defaults to ‘localhost’)

  • port the port number the WPE is listening no (defaults to 80 unless ssl true which sets it to 443)

  • account_name the default account name to log in to databases with (you can also supply a account name on a per-database basis if necessary)

  • password the default password to log in to databases with (you can also supplly a password on a per-databases basis if necessary)

  • log_actions when true, RFM logs all action URLs that are sent to FileMaker server to stderr (defaults to false)

  • log_responses when true, RFM logs all raw XML responses (including headers) from FileMaker to stderr (defaults to false)

  • warn_on_redirect normally, RFM prints a warning to stderr if the Web Publishing Engine redirects (this can usually be fixed by using a different host name, which speeds things up); if you *don’t* want this warning printed, set warn_on_redirect to true

  • raise_on_401 although RFM raises error when FileMaker returns error responses, it typically ignores FileMaker’s 401 error (no records found) and returns an empty record set instead; if you prefer a raised error when a find produces no errors, set this option to true

SSL Options (SSL AND CERTIFICATE VERIFICATION ARE ON BY DEFAULT):

  • ssl false if you want to turn SSL (HTTPS) off when connecting to connect to FileMaker (default is true)

If you are using SSL and want to verify the certificate use the following options:

  • root_cert false if you do not want to verify your SSL session (default is true). You will want to turn this off if you are using a self signed certificate and do not have a certificate authority cert file. If you choose this option you will need to provide a cert root_cert_name and root_cert_path (if not in root directory).

  • root_cert_name name of pem file for certificate verification (Root cert from certificate authority who issued certificate. If self signed certificate do not use this option!!). You can download the entire bundle of CA Root Certificates from curl.haxx.se/ca/cacert.pem. Place the pem file in config directory.

  • root_cert_path path to cert file. (defaults to ‘/’ if no path given)

Configuration Examples:

Example to turn off SSL:

myServer = Rfm::Server.new({
        :host => 'localhost',
        :account_name => 'sample',
        :password => '12345',
        :ssl => false 
        })

Example using SSL without root_cert:

myServer = Rfm::Server.new({
        :host => 'localhost',
        :account_name => 'sample',
        :password => '12345',
        :root_cert => false 
        })

Example using SSL with root_cert at file root:

myServer = Rfm::Server.new({
         :host => 'localhost',
         :account_name => 'sample',
         :password => '12345',
         :root_cert_name => 'example.pem' 
         })

Example using SSL with root_cert specifying root_cert_path:

myServer = Rfm::Server.new({
         :host => 'localhost',
         :account_name => 'sample',
         :password => '12345',
         :root_cert_name => 'example.pem'
         :root_cert_path => '/usr/cert_file/'
         })



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/rfm/server.rb', line 196

def initialize(options)
  @state = {
    :host => 'localhost',
    :port => 80,
    :ssl => true,
    :root_cert => true,
    :root_cert_name => '',
    :root_cert_path => '/',
    :account_name => '',
    :password => '',
    :log_actions => false,
    :log_responses => false,
    :warn_on_redirect => true,
    :raise_on_401 => false,
    :timeout => 60
  }.merge(options)

  @state.freeze

  @host_name = @state[:host]
  @scheme = @state[:ssl] ? "https" : "http"
  @port = @state[:ssl] && options[:port].nil? ? 443 : @state[:port]

  @db = Rfm::Factory::DbFactory.new(self)
end

Instance Attribute Details

#db ⇒ Object (readonly)

Returns the value of attribute db.



238
239
240
 
# File 'lib/rfm/server.rb', line 238

def db
  @db
end

#host_name ⇒ Object (readonly)

Returns the value of attribute host_name.



238
239
240
 
# File 'lib/rfm/server.rb', line 238

def host_name
  @host_name
end

#port ⇒ Object (readonly)

Returns the value of attribute port.



238
239
240
 
# File 'lib/rfm/server.rb', line 238

def port
  @port
end

#scheme ⇒ Object (readonly)

Returns the value of attribute scheme.



238
239
240
 
# File 'lib/rfm/server.rb', line 238

def scheme
  @scheme
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



238
239
240
 
# File 'lib/rfm/server.rb', line 238

def state
  @state
end

Instance Method Details

#[](dbname) ⇒ Object

Access the database object representing a database on the server. For example:

myServer['Customers']

would return a Database object representing the Customers database on the server.

Note: RFM never talks to the server until you perform an action. The database object returned is created on the fly and assumed to refer to a valid database, but you will get no error at this point if the database you access doesn’t exist. Instead, you’ll receive an error when you actually try to perform some action on a layout from this database.



234
235
236
 
# File 'lib/rfm/server.rb', line 234

def [](dbname)
  self.db[dbname]
end

#connect(account_name, password, action, args, options = {}) ⇒ Object

Performs a raw FileMaker action. You will generally not call this method directly, but it is exposed in case you need to do something “under the hood.”

The action parameter is any valid FileMaker web url action. For example, -find, -finadny etc.

The args parameter is a hash of arguments to be included in the action url. It will be serialized and url-encoded appropriately.

The options parameter is a hash of RFM-specific options, which correspond to the more esoteric FileMaker URL parameters. They are exposed separately because they can also be passed into various methods on the Layout object, which is a much more typical way of sending an action to FileMaker.

This method returns the Net::HTTP response object representing the response from FileMaker.

For example, if you wanted to send a raw command to FileMaker to find the first 20 people in the “Customers” database whose first name is “Bill” you might do this:

response = myServer.connect(
  '-find',
  {
    "-db" => "Customers",
    "-lay" => "Details",
    "First Name" => "Bill"
  },
  { :max_records => 20 }
)



267
268
269
270
 
# File 'lib/rfm/server.rb', line 267

def connect(, password, action, args, options = {})
  post = args.merge(expand_options(options)).merge({action => ''})
  http_fetch(@host_name, @port, "/fmi/xml/fmresultset.xml", , password, post)
end

#load_layout(layout) ⇒ Object 



272
273
274
275
276
 
# File 'lib/rfm/server.rb', line 272

def load_layout(layout)
  post = {'-db' => layout.db.name, '-lay' => layout.name, '-view' => ''}
  resp = http_fetch(@host_name, @port, "/fmi/xml/FMPXMLLAYOUT.xml", layout.db., layout.db.password, post)
  remove_namespace(resp.body)
end

#remove_namespace(xml) ⇒ Object

Removes namespace from fmpxmllayout, so xpath will work



279
280
281
 
# File 'lib/rfm/server.rb', line 279

def remove_namespace(xml)
  xml.gsub('xmlns="http://www.filemaker.com/fmpxmllayout"', '')
end