CRioMMBrowser Class Reference

#include <RioMMBrowser.h>

Inherits CRioMMSlideShow.

Public Member Functions
	CRioMMBrowser (char *, unsigned int, RioBlock, struct timeval RTT_average)
	~CRioMMBrowser (void)
int	init (void)
int	Cleanup (void)
void	Stop (void)
bool	ChangeContext (const char *, int)
void	SyncSpecific (void)
int	ProcessSignal (int, void *)
bool	readSettings ()
void	writeDefaultSettings ()
Private Member Functions
void	SendCommandToNetscape (const char *)
int	OpenNetscapeWindow (void)
void	StartBrowser (void)
Window	mozilla_remote_find_window (void)
bool	mozilla_remote_check_window (void)
int	mozilla_remote_command (bool, const char *)
void	mozilla_remote_obtain_lock (void)
void	mozilla_remote_free_lock (void)
int	isMozillaWindow (Display *, Window)
Private Attributes
pid_t	browser_pid
char	NetscapeID [11]
Display *	dpy
Window	NetscapeWindow
Atom	XA_MOZILLA_VERSION
Atom	XA_MOZILLA_LOCK
Atom	XA_MOZILLA_COMMAND
Atom	XA_MOZILLA_RESPONSE
char *	lock_data
QStringList *	browserCmdLine
pthread_t	tid

---

Detailed Description

Definition at line 46 of file RioMMBrowser.h.

---

Constructor & Destructor Documentation

CRioMMBrowser::CRioMMBrowser	(	char *	VideoName,
		unsigned int	blocksize,
		RioBlock	numBuffers,
		struct timeval	RTT_average
	)

Definition at line 41 of file RioMMBrowser.cpp.

               : CRioMMSlideShow( VideoName, blocksize, numBuffers , RTT_average )
{
    /* Media Synchronization Language Version */
    Major     = 1;
    Minor     = 0;

    /* There are no Netscape specific commands */
    CommandsList     = NULL;
    NumberOfCommands = 0;

    /* Initialize X-Windows data */
    dpy            = 0x0;
    NetscapeWindow = 0x0;
    lock_data      = NULL;
    tid            = 0;
    browser_pid    = 0;
    browserCmdLine = NULL;
}

CRioMMBrowser::~CRioMMBrowser

(

void

)

Definition at line 64 of file RioMMBrowser.cpp.

{
    Cleanup();
}

---

Member Function Documentation

bool CRioMMBrowser::ChangeContext	(	const char *	file_name,
		int	slide_number
	)			[virtual]

Reimplemented from CRioMMSlideShow.

Definition at line 119 of file RioMMBrowser.cpp.

{
    TString NextFileName;

    if( !NetscapeWindow )
        NetscapeWindow = mozilla_remote_find_window();

    if( !NetscapeWindow || !dpy )
        return false;

    NextFileName = file_name;
    if( NextFileName != CurrentFileName )
    {
        if( NextFileName.BeginsWith( "LOCAL:" ) )
        {
            Command = "openFile(" + TempDirectory + "/" +
                      NextFileName.Substring( strlen( "LOCAL:" ) ) + ")";
        }
        else
        {
            Command = "openURL(" + NextFileName + ")";
        }

        SendCommandToNetscape( Command );
    }

    CRioMMSlideShow::ChangeContext( file_name, slide_number );

    return true;
}

int CRioMMBrowser::Cleanup

(

void

)

[virtual]

Implements CRioMMSlideShow.

Definition at line 90 of file RioMMBrowser.cpp.

{
    if( NetscapeWindow )
    {
        if( mozilla_remote_check_window() )
            SendCommandToNetscape( "close()" );
        /* Close seems to not work if it is the last window */
        if( mozilla_remote_check_window() )
            SendCommandToNetscape( "exit()" );

        NetscapeWindow = 0;
    }

    if( dpy )
    {
        XCloseDisplay( dpy );
        dpy = NULL;
    }

    return 1;
}

int CRioMMBrowser::init

(

void

)

[virtual]

Reimplemented from CRioMMSlideShow.

Definition at line 70 of file RioMMBrowser.cpp.

{
    dpy = XOpenDisplay( NULL );
    if( dpy == NULL )
        return 0;

    XA_MOZILLA_VERSION  = XInternAtom( dpy, MOZILLA_VERSION_PROP,  False );
    XA_MOZILLA_LOCK     = XInternAtom( dpy, MOZILLA_LOCK_PROP,     False );
    XA_MOZILLA_COMMAND  = XInternAtom( dpy, MOZILLA_COMMAND_PROP,  False );
    XA_MOZILLA_RESPONSE = XInternAtom( dpy, MOZILLA_RESPONSE_PROP, False );

    if( !readSettings() )
        writeDefaultSettings();

    OpenNetscapeWindow();

    return( 1 );
}

int CRioMMBrowser::isMozillaWindow	(	Display *	dpy,
		Window	w
	)			[private]

Definition at line 329 of file RioMMBrowser.cpp.

{
    int           status;
    XTextProperty titleName;

    status = 0;
    if( XGetWMName( dpy, w, &titleName ) != 0 )
    {
        if( titleName.encoding == XA_STRING )
        {
            const char *t_dir = (const char *)TempDirectory;
            if( strncmp( t_dir, (char *)titleName.value, strlen(t_dir) ) == 0 )
                status = 1;
        }
    }

    return( status );
}

bool CRioMMBrowser::mozilla_remote_check_window

(

void

)

[private]

Definition at line 388 of file RioMMBrowser.cpp.

{
    Atom type;
    int format;
    bool retCode;
    unsigned long nitems, bytesafter;
    unsigned char *version = 0;
    int status = XGetWindowProperty( dpy, NetscapeWindow, XA_MOZILLA_VERSION,
                                     0, (65536 / sizeof( int )),
                                     False, XA_STRING,
                                     &type, &format, &nitems, &bytesafter,
                                     &version );

    retCode = false;
    if(status != Success || !version)
    {
        #ifdef RIO_DEBUG2
        RioErr << "RioNetscape: window " << showbase << hex 
               << (unsigned int) NetscapeWindow << noshowbase << dec 
               << " is not a Netscape window." << endl;
        #endif
    }
    else
    {
        retCode = true;
    }
    XFree( version );

    return( retCode );
}

int CRioMMBrowser::mozilla_remote_command	(	bool	raise_p,
		const char *	command
	)			[private]

Definition at line 421 of file RioMMBrowser.cpp.

{
    int result;
    Bool done = False;
    char new_command[ 255 ];

    result = False;
    /* The -noraise option is implemented by passing a "noraise" argument
       to each command to which it should apply.
    */
    if( !raise_p )
    {
        char *close;
        strcpy (new_command, command);
        close = strrchr (new_command, ')');
        if( close )
            strcpy (close, ", noraise)");
        else
            strcat (new_command, "(noraise)");
        command = new_command;
    }

    XChangeProperty( dpy, NetscapeWindow, XA_MOZILLA_COMMAND, XA_STRING, 8,
                     PropModeReplace, (unsigned char *)command,
                     strlen( command ) );

    while( !done )
    {
        XEvent event;
        XNextEvent( dpy, &event );
        if( event.xany.type             == DestroyNotify &&
            event.xdestroywindow.window == NetscapeWindow )
        {
            /* Print to warn user...*/
            #ifdef RIO_DEBUG2
            RioErr << "RioNetscape: window " << showbase << hex 
                   << (unsigned int) NetscapeWindow << noshowbase << dec 
                   << " was destroyed." << endl;
            #endif
            
            result = 6;
            goto DONE;
        }
        else if( event.xany.type        == PropertyNotify   &&
                 event.xproperty.state  == PropertyNewValue &&
                 event.xproperty.window == NetscapeWindow   &&
                 event.xproperty.atom   == XA_MOZILLA_RESPONSE )
        {
            Atom actual_type;
            int actual_format;
            unsigned long nitems, bytes_after;
            unsigned char *data = 0;

            result = XGetWindowProperty( dpy, NetscapeWindow,
                                         XA_MOZILLA_RESPONSE,
                                         0, (65536 / sizeof (int)),
                                         True, /* atomic delete after */
                                         XA_STRING,
                                         &actual_type, &actual_format,
                                         &nitems, &bytes_after,
                                         &data );
            
            #ifdef RIO_DEBUG2
            if( result == Success && data && *data )
            {
                RioErr << "RioNetscape: (server sent " << MOZILLA_RESPONSE_PROP 
                       << " \"" << data << "\" to " << showbase << hex 
                       << (unsigned int) NetscapeWindow << noshowbase << dec 
                       << ".)" << endl;
                         
            }
            #endif

            if(result != Success)
            {
                #ifdef RIO_DEBUG2
                RioErr << "RioNetscape: failed reading " 
                       << MOZILLA_RESPONSE_PROP << " from window " << showbase 
                       << hex << (unsigned int) NetscapeWindow << noshowbase 
                       << dec << "." << endl;
                #endif
                
                result = 6;
                done = True;
            }
            else if(!data || strlen((char *) data) < 5)
            {
                #ifdef RIO_DEBUG2
                RioErr << "RioNetscape: invalid data on " 
                       << MOZILLA_RESPONSE_PROP << " property of window " 
                       << showbase << hex << (unsigned int) NetscapeWindow 
                       << noshowbase << dec << "." << endl;
                #endif
                
                result = 6;
                done   = True;
            }
            else if(*data == '1') /* positive preliminary reply */
            {
                #ifdef RIO_DEBUG2
                RioErr << "RioNetscape: " << data + 4 << endl; 
                #endif
                
                /* keep going */
                done = False;
            }
            else if( !strncmp( (char *)data, "200", 3 ) ) /* positive completion */
            {
                result = 0;
                done   = True;
            }
            else if( *data == '2' ) /* positive completion */
            {
                #ifdef RIO_DEBUG2
                RioErr << "RioNetscape: " << data + 4 << endl; 
                #endif
                
                result = 0;
                done = True;
            }
            else if( *data == '3' ) /* positive intermediate reply */
            {
                #ifdef RIO_DEBUG2
                RioErr << "RioNetscape: internal error: server wants more "
                       << "information? (" << data << ")" << endl;
                #endif
          
                result = 3;
                done = True;
            }
            else if( *data == '4' ||  /* transient negative completion */
                     *data == '5')    /* permanent negative completion */
            {
                result = (*data - '0');
                done = True;
            }
            else
            {
                #ifdef RIO_DEBUG2
                RioErr << "RioNetscape: unrecognised " 
                       << MOZILLA_RESPONSE_PROP << " from window " << showbase 
                       << hex << (unsigned int) NetscapeWindow << noshowbase 
                       << dec << ": " << data << endl;
                #endif
                
                result = 6;
                done = True;
            }

            if( data )
                XFree( data );
        }
        #ifdef DEBUG_PROPS
        else if( event.xany.type == PropertyNotify &&
                 event.xproperty.window == window &&
                 event.xproperty.state == PropertyDelete &&
                 event.xproperty.atom == XA_MOZILLA_COMMAND)
        {
            RioErr << "RioNetscape: (server " << showbase << hex 
                   << (unsigned int) NetscapeWindow << noshowbase << dec
                   << " has accepted " << MOZILLA_RESPONSE_PROP << ".)"  
                   << endl;
        }
        #endif /* DEBUG_PROPS */
    } //fim do while( !done )

DONE:

    return result;
}

Window CRioMMBrowser::mozilla_remote_find_window

(

void

)

[private]

Definition at line 348 of file RioMMBrowser.cpp.

{
    int           i;
    unsigned int  nkids;
    Window        rw;
    Window        root;
    Window        parent;
    Window       *kids;
    Window        curWindow;

    i         = -1;
    curWindow =  0;
    
    if( dpy == 0 )
        return 0;
    
    rw = RootWindowOfScreen( DefaultScreenOfDisplay( dpy ) );
    /* List all windows in the current root window */
    if( XQueryTree( dpy, rw, &root, &parent, &kids, &nkids ) )
    {
        if( nkids > 0 && kids != NULL )
        {
            /* We search backwards since the newest windows are at the end */
            for( i = nkids - 1; i >= 0; i-- )
            {
                /* Get the wid of the current window */
                curWindow = XmuClientWindow( dpy, kids[ i ] );
                if( isMozillaWindow( dpy, curWindow ) )
                    break;
            }
        }
        XFree( kids );
    }

    if( i < 0 )
        curWindow = 0;

    return( curWindow );
}

void CRioMMBrowser::mozilla_remote_free_lock

(

void

)

[private]

Definition at line 693 of file RioMMBrowser.cpp.

{
    int result;
    Atom actual_type;
    int actual_format;
    unsigned long nitems, bytes_after;
    unsigned char *data = 0;

    result = XGetWindowProperty( dpy, NetscapeWindow, XA_MOZILLA_LOCK,
                                 0, (65536 / sizeof (int)),
                                 True, /* atomic delete after */
                                 XA_STRING,
                                 &actual_type, &actual_format,
                                 &nitems, &bytes_after,
                                 &data );
    if( result != Success )
    {
        #ifdef RIO_DEBUG2
        RioErr << ": unable to read and delete " << MOZILLA_LOCK_PROP 
               << " property" << endl;
        #endif
        
        return;
    }
    else if( !data || !*data )
    {
        #ifdef RIO_DEBUG2
        RioErr << ": invalid data on " << MOZILLA_LOCK_PROP << " of window "
               << showbase << hex << (unsigned int) NetscapeWindow 
               << noshowbase << dec << "." << endl;
        #endif
        
        return;
    }
    else if( strcmp( (char *) data, lock_data) )
    {
        #ifdef RIO_DEBUG2
        RioErr << ": " << MOZILLA_LOCK_PROP << " was stolen! Expected \"" 
               << lock_data << "\", saw \"" << data << "\"!" << endl;
        #endif
        
        return;
    }

    if( data )
        XFree( data );
}

void CRioMMBrowser::mozilla_remote_obtain_lock

(

void

)

[private]

Definition at line 592 of file RioMMBrowser.cpp.

{
    bool locked = false;
    bool waited = false;

    if( !lock_data )
    {
        lock_data = (char *) malloc(255);
        sprintf( lock_data, "pid%d@", getpid() );
        if( gethostname( lock_data + strlen( lock_data ), 100) )
        {
            Rioperror("gethostname");
            exit (-1);
        }
    }

    do
    {
        int result;
        Atom actual_type;
        int actual_format;
        unsigned long nitems, bytes_after;
        unsigned char *data = 0;

        XGrabServer( dpy );   /* ################################# DANGER! */

        result = XGetWindowProperty( dpy, NetscapeWindow, XA_MOZILLA_LOCK,
                                     0, (65536 / sizeof( int )),
                                     False, /* don't delete */
                                     XA_STRING,
                                     &actual_type, &actual_format,
                                     &nitems, &bytes_after,
                                     &data );
        if( result != Success || actual_type == None )
        {
             // It's not now locked - lock it.
             XChangeProperty( dpy, NetscapeWindow, XA_MOZILLA_LOCK, XA_STRING,
                              8, PropModeReplace, (unsigned char *) lock_data,
                              strlen( lock_data ) );
             locked = true;
        }

        XUngrabServer( dpy ); /* ################################# danger over */
        XSync( dpy, 0 );
        
        if( !locked )
        {
            /* We tried to grab the lock this time, and failed because someone
               else is holding it already.  So, wait for a PropertyDelete event
               to come in, and try again. */
        
            #ifdef RIO_DEBUG2
            RioErr << ": window " << showbase << hex 
                   << (unsigned int) NetscapeWindow << noshowbase << dec
                   << " is locked by " << data << "; waiting..." << endl;
            #endif
            
            waited = true;
        
            while( 1 )
            {
                XEvent event;
                XNextEvent( dpy, &event );
                if( event.xany.type             == DestroyNotify &&
                    event.xdestroywindow.window == NetscapeWindow )
                {
                    RioErr << ": window " << showbase << hex 
                           << (unsigned int) NetscapeWindow << noshowbase << dec
                           << " unexpectedly destroyed." << endl;
                    exit (6);
                }
                else if( event.xany.type        == PropertyNotify &&
                         event.xproperty.state  == PropertyDelete &&
                         event.xproperty.window == NetscapeWindow &&
                         event.xproperty.atom   == XA_MOZILLA_LOCK )
                {
                    /* Ok!  Someone deleted their lock, so now we can try
                       again. */
                    #ifdef DEBUG_PROPS
                    RioErr << ": (" << showbase << hex 
                           << (unsigned int) NetscapeWindow << noshowbase << dec
                           << " unlocked, trying again...)" << endl;
                    #endif
                    
                    break;
                }
            } //fim do while( 1 )
        } // fim do if( !locked )
        
        if( data )
            XFree( data );
    }

    //FIXME: Busy wait aqui! Usar algo mais inteligente!
    while(!locked );

    if( waited )
        RioErr << ": obtained lock." << endl;
}

int CRioMMBrowser::OpenNetscapeWindow

(

void

)

[private]

Definition at line 201 of file RioMMBrowser.cpp.

{
    int status;

    status = 0;
    if( !NetscapeWindow )
    {
        if( !(NetscapeWindow = mozilla_remote_find_window()) )
            StartBrowser();
    }
    else
    {
        if( !mozilla_remote_check_window() )
            StartBrowser();
    }

    if( (NetscapeWindow = mozilla_remote_find_window()) )
        status = 1;
    
    return( status );
}

int CRioMMBrowser::ProcessSignal	(	int	sig,
		void *	data
	)			[virtual]

Reimplemented from CRioMMObject.

Definition at line 243 of file RioMMBrowser.cpp.

{
    int status;

    status = 0;
    switch( sig )
    {
        case SIGHUP:
            readSettings();
            break;

        case SIGCHLD:
            if( (long)data == browser_pid )
                dpy = 0x0;
            break;
    }

    /* if it is not fatal, forward signal to the slave medias */
    if( status != 2 )
        CRioMMObject::ProcessSignal( sig, data );

    return( status );
}

bool CRioMMBrowser::readSettings

(

void

)

Definition at line 290 of file RioMMBrowser.cpp.

{
    ConfigData  config;
    bool        ok1 = false,
                ok2 = false;
    QString     browserPath, opt_value, temp;
    QStringList args;

    config.readRioMMClientSettings();
    opt_value = config.getRioMMBVersion();
    if( opt_value != QString::null )
    {
        //Se a versao do arquivo riorc for diferente de RIORC_RIOMMBROWSER_VERSION, seus dados
        //ser�o ignorados e os valores defaults ser�o escritos no mesmo atrav�s da
        //fun��o writeDefaultSettings assim que esta fun��o retornar false.
        if( opt_value == RIORC_RIOMMBROWSER_VERSION )
        {
            ok1 = true;

            opt_value = QString::null;
            opt_value = config.getRioMMBBrowser();

            if( opt_value != QString::null )
            {
                ok2 = true;
                if( browserCmdLine )
                    delete browserCmdLine;
                browserCmdLine = new QStringList();
                browserCmdLine->append( config.getRioMMBBinary() );
                args = QStringList::split( " ", config.getRioMMBArguments() );
                *browserCmdLine += args;

            }
        }
    }

    return( ok1 && ok2 );
}

void CRioMMBrowser::SendCommandToNetscape

(

const char *

command

)

[private]

Definition at line 223 of file RioMMBrowser.cpp.

{
    int status;

    XSelectInput( dpy, NetscapeWindow, (PropertyChangeMask|StructureNotifyMask) );

    mozilla_remote_obtain_lock();

    status = mozilla_remote_command( false, command );

    if( status != 6 )
        mozilla_remote_free_lock();
}

void CRioMMBrowser::StartBrowser

(

void

)

[private]

Definition at line 156 of file RioMMBrowser.cpp.

{
    TString url( "file://" );

    if( (browser_pid = fork()) != 0 )
    {
        if( browser_pid < 0 )
        {
            #ifdef RIO_DEBUG2
            RioErr << "fork(). Failed to fork process." << endl;
            #endif
            
            return;
        }
        sleep( 2 );
    }
    else
    {
        int    argc;
        char **argv;
        QString aux("");

        argc = 0;
        argv = (char **)malloc(sizeof( char * )* (browserCmdLine->count() + 1));
        CreateFakeSlide();
        url += TempDirectory + "/init.html";

        for( QStringList::Iterator it = browserCmdLine->begin(); it != browserCmdLine->end(); it++ )
        {
            (*it).replace( "%u", QString( (const char *)url ) );
            argv[ argc++ ] = strdup( (*it).latin1() );
            aux += " " + (*it);
        }
        argv[ argc++ ] = NULL;

        //run browser
        if( execvp( argv[ 0 ], argv ) == -1 )
        {
            RioErr << "execlp(): Failed to execute browser command:" << endl;
            RioErr << "  " << aux.latin1() << endl;
            return;
        }
    }
}

void CRioMMBrowser::Stop

(

void

)

[virtual]

Reimplemented from CRioMMSlideShow.

Definition at line 113 of file RioMMBrowser.cpp.

{
    CRioMMSlideShow::Stop();
}

void CRioMMBrowser::SyncSpecific

(

void

)

[virtual]

Implements CRioMMSlideShow.

Definition at line 150 of file RioMMBrowser.cpp.

{
    if( dpy )
        XSync( dpy, 0 );
}

void CRioMMBrowser::writeDefaultSettings

(

void

)

Definition at line 273 of file RioMMBrowser.cpp.

{
    ConfigData config;
    QStringList args;
    config.writeDefaultRioMMBrowserSettings();
    config.readRioMMClientSettings();

    browserCmdLine = new QStringList( DEFAULT_BROWSER );
    args = QStringList::split( " ", config.getRioMMBArguments() );
    *browserCmdLine += args;
}

---

Field Documentation

pid_t CRioMMBrowser::browser_pid [private]

Definition at line 49 of file RioMMBrowser.h.

QStringList* CRioMMBrowser::browserCmdLine [private]

Definition at line 59 of file RioMMBrowser.h.

Display* CRioMMBrowser::dpy [private]

Definition at line 52 of file RioMMBrowser.h.

char* CRioMMBrowser::lock_data [private]

Definition at line 58 of file RioMMBrowser.h.

char CRioMMBrowser::NetscapeID[11] [private]

Definition at line 50 of file RioMMBrowser.h.

Window CRioMMBrowser::NetscapeWindow [private]

Definition at line 53 of file RioMMBrowser.h.

pthread_t CRioMMBrowser::tid [private]

Definition at line 61 of file RioMMBrowser.h.

Atom CRioMMBrowser::XA_MOZILLA_COMMAND [private]

Definition at line 56 of file RioMMBrowser.h.

Atom CRioMMBrowser::XA_MOZILLA_LOCK [private]

Definition at line 55 of file RioMMBrowser.h.

Atom CRioMMBrowser::XA_MOZILLA_RESPONSE [private]

Definition at line 57 of file RioMMBrowser.h.

Atom CRioMMBrowser::XA_MOZILLA_VERSION [private]

Definition at line 54 of file RioMMBrowser.h.

---

The documentation for this class was generated from the following files:

• RioMMBrowser.h
• RioMMBrowser.cpp