Re: ISPMAN API

On Thu, 2004-06-24 at 08:04, Cory Petkovsek wrote:
> 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.

The contained perl doc tags are actually a nice thing, because you can
easily generate an API doc from that with perldoc.
That depends on all subs having those tags, though.

> 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.

The problem is, the ispman libs have grown over some years now and IMHO
really got messy (regarding a clean API):
* superfluous/over-specialized functions
* no strict naming of functions
* mixed up subs for UI processing and backend funtions

I'm eager to reorganize much of that actually, but that takes some time,
and so you shouldn't bother about that currently since it would just
delay other important development (eg. CCP).

Thus, documenting the status quo is probably wasted effort right now...

Joerg




-------------------------------------------------------
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