Re: ISPMAN API

On Wed, Jun 23, 2004 at 10:15:04PM -0500, Serving  wrote:
> I wonder if there is an API for ispman ?  There was a SOAP server attempt
> about 2 years ago by Atif that was abandoned for lack of general interest. 

There is an API.  Some of it is even documented.  You can tell because of
everything in the /lib directory.  ISPMan is a package.  The problem is that
things are kind of messy and the bigger problem is that the API is
undocumented.  Or at least, what is documented is spread around.

One of the things I'd like to see happen is this API become more formal and
documented.  I will need it in redesigning CustomerMan.

What was the SOAP server?  I know SOAP in the context of xml parsing.


> Any chance this can be revived and documented so that external apps can be
> written that interface successfully with ispman? I am thinking about
> billing, signup, GUIs and such. 

use ISPMan;

That's a start.  We need documentation.  I will be doing that as a necessary
part.  If you want to help, you could start a document that listed all of the
functions under /lib.  List the package, file they are in and try to determine
their input and output types.  Ever seen a java api?
http://java.sun.com/j2se/1.3/docs/api/

Some parts of the package have perldoc, embedded help within the file.  This
is useful, but not as useful as a full api document.  This can be separated
from the perl document by running 'perldoc lib/ISPMan.pm'.  Here's an example
of what would be a great start for ispman: 

Package: ISPMan
File: lib/ISPMan/DomainMan.pm 
addDomain(self?, CGI $r)
    Adds a domain with reseller and client ids to system.  It's unclear what
    datatype self is.

getDomains()
    Returns a reference to a hash of all domains managed in ldap
    

> 18 months ago I proposed pooling some resources from companies and
> individuals benefiting from ispman and hire a good programmer(s) from
> wherever good programmers are outsourced from. 
> 
> Lead ispman developers can spend more time on software designs than on
> coding and debugging. Hopefully, it will speed the release cycle to 4-5
> releases a year instead of only 2.  

It still has to be maintained after that in order to continue the regular the
release cycle.  ISPMan has problems, but over all it is fairly descent.  It
utilizes some good underlying technologies (postfix, openldap, perl, etc) and
has a descent framework.  I'm just starting working on the ispman code base,
but don't see a need to hire anyone.  I think that as things grow the more
people will be interested and as Atif doles out CVS access to interested
developers then it will naturally attract people.

Cory

-- 
Cory Petkovsek                                       Adapting Information
Adaptable IT Consulting                                Technology to Your
(858) 705-1655                                                   Business
cory-p3//[email protected]                                  www.AdaptableIT.com


-------------------------------------------------------
This SF.Net email sponsored by Black Hat Briefings & Training.
Attend Black Hat Briefings & Training, Las Vegas July 24-29 - 
digital self defense, top technical experts, no vendor pitches, 
unmatched networking opportunities. Visit www.blackhat.com