contentLister/inc/programManager.h File Reference

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <gtk/gtk.h>
#include <gdk/gdkx.h>
#include <X11/Xatom.h>
#include "liberipc/eripc.h"
#include <liberregxml/erregapi.h>

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	erExtInfo_t
struct	erXClient_t
struct	erApplicationInfo_t
Defines
#define	WM_NAME_MAX   256
#define	PM_DOWNLOADMGR_LOCATION   "/usr/bin/downloadMgr"
#define	XCLIENT_ARRAY_RESERVED_SIZE   32
#define	CONTENTLISTER_UAID   "CONTENTLISTER"
#define	CONTENTLISTER_RESNAME   "contentLister"
#define	WINDOWMANAGER_NAME_MAX   256
#define	UAID_MAX_SIZE   256
#define	COMMAND_MAX_SIZE   1024
#define	ERR_OK   ( 0)
#define	ERR_STATE_UPDATE   (-1)
#define	ERR_ARGUMENT   (-2)
#define	ERR_FORK   (-3)
#define	ERR_INVALID_UAID   (-4)
#define	ERR_VIEWER_RUNNING   (-5)
Functions
gboolean	pm_InitProgramManager (void)
void	pm_SetMyWindow (Window window)
void	pm_DestroyProgramManager (void)
gboolean	pm_RaiseContentLister ()
gboolean	pm_RaiseUserApp (gchar *uaId)
gboolean	pm_IsActive (gchar *uaId)
char *	pm_getUaOnTop (void)
void	pm_setUaOnTop (char *uaID)
void	pm_SendKey (KeySym keysym)
int	pm_RunViewer (gchar *uaId, char *filename, char *manifest, char *options, int reuse)
char *	pm_getUaID (char *extension)
char *	pm_getIcon (char *extension)

---

Define Documentation

#define COMMAND_MAX_SIZE   1024

Definition at line 54 of file programManager.h.

#define CONTENTLISTER_RESNAME   "contentLister"

Definition at line 51 of file programManager.h.

#define CONTENTLISTER_UAID   "CONTENTLISTER"

Definition at line 50 of file programManager.h.

#define ERR_ARGUMENT   (-2)

Definition at line 58 of file programManager.h.

#define ERR_FORK   (-3)

Definition at line 59 of file programManager.h.

#define ERR_INVALID_UAID   (-4)

Definition at line 60 of file programManager.h.

#define ERR_OK   ( 0)

Definition at line 56 of file programManager.h.

#define ERR_STATE_UPDATE   (-1)

Definition at line 57 of file programManager.h.

#define ERR_VIEWER_RUNNING   (-5)

Definition at line 61 of file programManager.h.

#define PM_DOWNLOADMGR_LOCATION   "/usr/bin/downloadMgr"

Definition at line 47 of file programManager.h.

#define UAID_MAX_SIZE   256

Definition at line 53 of file programManager.h.

#define WINDOWMANAGER_NAME_MAX   256

Definition at line 52 of file programManager.h.

#define WM_NAME_MAX   256

Definition at line 45 of file programManager.h.

#define XCLIENT_ARRAY_RESERVED_SIZE   32

Definition at line 49 of file programManager.h.

---

Function Documentation

void pm_DestroyProgramManager

(

void

)

Destroy the global data used by the program manager module

Returns:

TRUE in case of succes

Definition at line 162 of file programManager.c.

{
    CL_PMPRINTF("entry");
    signal(SIGCHLD, SIG_IGN);

    // Do NOT destroy data, these are used even after pm_DestroyProgramManager()
    // Let's rely on the OS to free all memory when the contentLister exits.
    // g_hash_table_destroy(g_extensionInfo);
    // g_hash_table_destroy(g_programInfo);
    // g_array_free(g_xClientInfo, TRUE);
}

char* pm_getIcon

(

char *

extension

)

Returns the READ ONLY icon location for this extension.

returned value is READ ONLY

Definition at line 289 of file programManager.c.

{
    erExtInfo_t *theExtInfo = NULL;

    if (extension)
    {
        theExtInfo = g_hash_table_lookup(g_extensionInfo, extension);

        if (theExtInfo)
        {
            CL_PMPRINTF("iconLocation %s - extension %s",
                        (theExtInfo->iconLocation == NULL) ? "NULL" : theExtInfo->iconLocation, extension);
            return theExtInfo->iconLocation;
        }
    }

    return NULL;
}

char* pm_getUaID

(

char *

extension

)

Returns the READ ONLY uaID assocaited with this extension.

returned value is READ ONLY

Definition at line 270 of file programManager.c.

{
    erExtInfo_t *theExtInfo = NULL;

    CL_PMPRINTF("entry");

    if (extension)
    {
        theExtInfo = g_hash_table_lookup(g_extensionInfo, extension);

        if (theExtInfo)
        {
            CL_PMPRINTF("uaID %s - extension %s", (theExtInfo->uaID == NULL) ? "NULL" : theExtInfo->uaID, extension);
            return theExtInfo->uaID;
        }
    }
    return NULL;
}

char* pm_getUaOnTop

(

void

)

Returns the uaID of the user application currently on top of the window stack.

returned value is READ ONLY

Definition at line 528 of file programManager.c.

{
    CL_PMPRINTF("return UaID [%s]", g_uaOnTop);
    return g_uaOnTop;
}

gboolean pm_InitProgramManager

(

void

)

create and init the global data used by the program manager module

Returns:

TRUE in case of succes

Definition at line 119 of file programManager.c.

{
    gboolean returnValue = TRUE;

    CL_PMPRINTF("entry");

    // Install Unix signal handlers
    signals_init();

    strncpy(g_uaOnTop, CONTENTLISTER_UAID, UAID_MAX_SIZE);
    strncpy(g_lastStartedUa, CONTENTLISTER_UAID, UAID_MAX_SIZE);
    g_myWin = -1; // Set this to the correct value when available with pm_SetMyWindow()
    g_xClientInfo = g_array_sized_new(FALSE, TRUE, sizeof(erXClient_t), XCLIENT_ARRAY_RESERVED_SIZE);

    returnValue = pm_InitProgramTable();
    if (returnValue)
    {
        pm_InitExtTable();
    }

    // install our own handler for X errors
    XSetErrorHandler(pm_XErrorHandler);

    return returnValue;
}

Here is the call graph for this function:

gboolean pm_IsActive

(

gchar *

uaId

)

Checks whether a specified viewer is already active.

Returns:

TRUE when active

Definition at line 423 of file programManager.c.

{
    int     nmbrOfXClients;
    erApplicationInfo_t *theAppInfo;

    CL_PMPRINTF("entry %s", (uaId == NULL) ? "NULL" : uaId);

    theAppInfo = (erApplicationInfo_t *) g_hash_table_lookup(g_programInfo, uaId);

    if (theAppInfo)
    {
        //Update the view on XClients
        nmbrOfXClients = pm_UpdateState();
        if (nmbrOfXClients < 0)
        {
            CL_ERRORPRINTF("Failed to update state");
            return FALSE;
        }

        // Patch the program table with the info retrieved on the XClients
        pm_PatchProgramTable();

        if (NULL != theAppInfo->xclient)
        {
            return TRUE;
        }
        else
        {
            return FALSE;
        }
    }
    else
    {
        CL_ERRORPRINTF("invalid uaID %s", (NULL == uaId) ? "NULL" : uaId);
        return FALSE;
    }
}

Here is the call graph for this function:

gboolean pm_RaiseContentLister

(

)

Raise the contentlister application

Returns:

TRUE in case of succes

Definition at line 308 of file programManager.c.

{
    Window  win = 0;
    Display *display;
    int     nmbrOfXClients;

    CL_PMPRINTF("entry");

    //Update the view on XClients
    nmbrOfXClients = pm_UpdateState();
    if (nmbrOfXClients < 0)
    {
        CL_ERRORPRINTF("Failed to update state");
        return FALSE;
    }

    // Patch the program table with the info retrieved on the XClients
    pm_PatchProgramTable();

    // The contentLister window
    win = g_myWin;
    display = gdk_x11_display_get_xdisplay(gdk_display_get_default());

    if (strcmp(pm_getUaOnTop(), CONTENTLISTER_UAID) != 0)
    {
        // minimize current application
        erApplicationInfo_t *theAppInfo= (erApplicationInfo_t *) 
            g_hash_table_lookup(g_programInfo, pm_getUaOnTop());
        pm_IconifyUserApp(NULL, theAppInfo, display);
        toolbar_restore();
    }

    // stop the user application that was on top,
    // in fact stop all user applications and viewers
    g_hash_table_foreach(g_programInfo, pm_TerminateUserApp, display);

    XRaiseWindow(display, win);
    XMapRaised(display, win);
    XFlush(display);
    pm_setUaOnTop(CONTENTLISTER_UAID);

    CL_PMPRINTF("end");
    return TRUE;
}

Here is the call graph for this function:

gboolean pm_RaiseUserApp

(

gchar *

uaId

)

Raise the specified used application

Returns:

TRUE in case of succes

Definition at line 353 of file programManager.c.

{
    Window  win = 0;
    Window  CL_win = 0;
    Display *display;
    int     nmbrOfXClients;
    int     index;
    erApplicationInfo_t *theAppInfo;
    int     screen;
    erXClient_t *client;

    CL_PMPRINTF("entry: uaId [%s]", uaId);

    theAppInfo = (erApplicationInfo_t *) g_hash_table_lookup(g_programInfo, uaId);

    if (theAppInfo)
    {
        //Update the view on XClients
        nmbrOfXClients = pm_UpdateState();
        if (nmbrOfXClients < 0)
        {
            CL_ERRORPRINTF("Failed to update state");
            return FALSE;
        }

        // Patch the program table with the info retrieved on the XClients
        pm_PatchProgramTable();

        // find viewer and contentlister window
        for (index = 0; index < g_xClientInfo->len; index++)
        {
            client = &g_array_index(g_xClientInfo, erXClient_t, index);

            if (strcmp(CONTENTLISTER_RESNAME, client->resName) == 0)
            {
                CL_win = client->win;
            }
            if (strcmp(theAppInfo->userApp->xResName, client->resName) == 0)
            {
                win = client->win;
            }
        }

        if ((win != 0) && (CL_win != 0))
        {
            screen = gdk_x11_get_default_screen();
            display = gdk_x11_display_get_xdisplay(gdk_display_get_default());

            CL_PMPRINTF("Lower CL window");
            XIconifyWindow(display, CL_win, screen);
            XRaiseWindow(display, win);
            XMapRaised(display, win);
            XFlush(display);
            pm_setUaOnTop(uaId);
            toolbar_clear();
            return TRUE;
        }
        else
        {
            CL_ERRORPRINTF("could not find window info");
            return FALSE;
        }
    }
    else
    {
        CL_ERRORPRINTF("invalid uaID %s", (NULL == uaId) ? "NULL" : uaId);
        return FALSE;
    }
}

Here is the call graph for this function:

int pm_RunViewer	(	gchar *	uaId,
		char *	filename,
		char *	manifest,
		char *	options,
		int	reuse
	)

Start/Show the specified viewer. In case the viewer supports re-displaying new content, this (generic) mechanism will be invoked

Parameters:

	userApplication	unique identifier
	filename	that needs to be passed to the viewer _FILENAME_ in registry [optional]
	manifest	that needs to be passed to the viewer _MANIFEST_ in regsitry [optional]
	options	that needs to be passed to the viewer [optional]
	reuse	if '1' a current instance of the viewer will gain focus and display the selected content. If no such instance is available a new instance will be created

Returns:

0 upon success. A negative value (ERR_INVALID_UAID, ERR_FORK, ERR_ARGUMENT ERR_STATE_UPDATE) in case of failure

Definition at line 681 of file programManager.c.

{
    pid_t   pid;
    int     nmbrOfXClients;
    erApplicationInfo_t *theAppInfo;
    Display *display;
    Window  ownWin = 0;
    int     index;
    erXClient_t *client;
    int     screen;
    GString *theCommand;

    theAppInfo = (erApplicationInfo_t *) g_hash_table_lookup(g_programInfo, (const char*)uaID);

    if (theAppInfo)
    {
        CL_PMPRINTF("App %s", theAppInfo->uaID);

        toolbar_clear();

        //Update the view on XClients
        nmbrOfXClients = pm_UpdateState();
        if (nmbrOfXClients < 0)
        {
            CL_ERRORPRINTF("Failed to update state");
            return (ERR_STATE_UPDATE);
        }

        // Patch the program table with the info retrieved on the XClients
        pm_PatchProgramTable();

        if (reuse == 1)
        {
            CL_PMPRINTF("Re-use process branch");

            // Is there already a process running?
            if (theAppInfo->pid != -1)
            {
                // TODO: Here I need to bring the selected app on top of the stack
                // and inform it on the new content to display
                CL_WARNPRINTF("TODO: Bring %s on top of window stack", uaID);

                if (theAppInfo->xclient != NULL)
                {
                    CL_PMPRINTF("Do something with %s 0x%xd",
                                theAppInfo->xclient->resName,
                                (unsigned int)theAppInfo->xclient->win);

                    CL_PMPRINTF("XRaiseWindow: 0x%x (window)", (unsigned int)theAppInfo->xclient->win);

                    display = gdk_x11_display_get_xdisplay(gdk_display_get_default());

                    // Iconize contentLister
                    for (index = 0; index < g_xClientInfo->len; index++)
                    {
                        client = &g_array_index(g_xClientInfo, erXClient_t, index);

                        if (strcmp(CONTENTLISTER_RESNAME, client->resName) == 0)
                        {
                            ownWin = client->win;
                            break;
                        }
                    }

                    if (ownWin != 0)
                    {
                        screen = gdk_x11_get_default_screen();

                        CL_PMPRINTF("Lower window %s", client->resName);
                        XIconifyWindow(display, ownWin, screen);
                    }

                    XMapRaised(display, theAppInfo->xclient->win);
                    XRaiseWindow(display, theAppInfo->xclient->win);
                    XFlush(display);
                    pm_setUaOnTop(uaID);

                    // done
                    return (ERR_OK);
                }
                else
                {
                    CL_ERRORPRINTF("Did not find xclient info on %s. Should I kill the process here????", uaID);
                }
            }
            // The else branch is implicit. Just create the process
        }
        else
        {
            CL_PMPRINTF("Create new process branch");

            // Is there already a process running?
            if (theAppInfo->pid != -1)
            {
                CL_WARNPRINTF("Process was already started, not starting it again!");
                return (ERR_VIEWER_RUNNING);
            }
            // The else branch is implicit. Just create the process
        }

        //handle the argument information
        theCommand = pm_CreateCommand(theAppInfo->userApp->szExec, theAppInfo->userApp->szArgMask, filename, manifest, options);

        if (theCommand)
        {
            CL_PMPRINTF("szCommand %s", theCommand->str);
        }
        else
        {
            CL_ERRORPRINTF("pm_CreateArgument can't create command");
            return (ERR_ARGUMENT);
        }

        // Check if ARINC viewer, this is a special case
        if (strcmp(uaID, ARINC_APP) == 0)
        {
            // For Arinc application, exec it, so that contentLister will be
            // replaced by eFlyBook

            // Make sure the executable exists; not only the symlink. Otherwise the iLiad will crash.
            char *p = realpath(theAppInfo->userApp->szExec, NULL); // p will be allocated by realpath
            if (p == NULL) 
            {
                CL_WARNPRINTF("Cannot find executable [%s]; not executing in place.", theAppInfo->userApp->szExec);
                return (ERR_FORK);
            }
            else
            {
                g_free(p); // free realpath allocated buffer
                int     nRet;
                CL_WARNPRINTF("Executing [%s] in place; replaces contentLister!", uaID);    
                nRet = shell_exec(theCommand->str);
                CL_ERRORPRINTF("shell_exec of [%s] failed!", uaID);
                CL_ERRORPRINTF("shell exec command [%s]", theCommand->str);
                CL_ERRORPRINTF("shell_exec returned %d", nRet);
                perror("Error upon calling shell_exec");
                fflush(stderr);
                return (ERR_FORK);
            }
        }
        else
        {
            erStopMSDiskApp();

            switch (pid = fork())
            {
                case 0:
                {
                    // Here I am in the child process
                    int     nRet;

                    nRet = shell_exec(theCommand->str);
                    CL_ERRORPRINTF("shell_exec of [%s] failed, cleaning up child", uaID);
                    CL_ERRORPRINTF("shell exec command [%s]", theCommand->str);
                    CL_ERRORPRINTF("shell_exec returned %d", nRet);
                    perror("Error upon calling shell_exec");
                    fflush(stderr);
                    sleep(1);
                    _exit(1);
                }
                case -1:
                    // something went wrong with fork => this is the parent process
                    CL_ERRORPRINTF("pmRunViewer: can't fork %s", uaID);
                    g_string_free(theCommand, TRUE);
                    erStartMSDiskApp();
                    return (ERR_FORK);
            }
        }

        // Child process started with succes => here the parent process continues
        // Store the pid
        theAppInfo->pid = pid;
        pm_setUaOnTop(uaID);
        pm_setLastStartedUa(uaID);
        g_string_free(theCommand, TRUE);
        return (ERR_OK);
    }
    else
    {
        CL_WARNPRINTF("invalid uaID %s", (NULL == uaID) ? "NULL" : uaID);
        return (ERR_INVALID_UAID);
    }

}

Here is the call graph for this function:

void pm_SendKey

(

KeySym

keysym

)

send button press signal to app on top.

Definition at line 461 of file programManager.c.

{
    XKeyEvent xev;
    Display *display;
    Window  window, root;
    int     screen;

    display = gdk_x11_display_get_xdisplay(gdk_display_get_default());
    root = gdk_x11_get_default_root_xwindow();
    window = pm_getWinOnTop();
    if (window == -1)
    {
        CL_ERRORPRINTF("Failed: no valid window found");
        return;
    }

    if (window == g_myWin)
    {
        CL_PMPRINTF("ContentLister window 0x%x", (unsigned int)window);

        display = XOpenDisplay(NULL);
        screen = DefaultScreen(display);
        root = RootWindow(display, screen);
    }

    // create and send a keypress event followed by a keyrelease event 
    xev.type = KeyPress;
    xev.display = display;
    xev.root = root;
    xev.window = window;
    xev.subwindow = None;
    xev.time = pm_fake_timestamp();
    xev.x = 1;
    xev.y = 1;
    xev.x_root = 1;
    xev.y_root = 1;
    xev.same_screen = 1;
    xev.state = 0;
    xev.keycode = XKeysymToKeycode(display, keysym);
//    CL_ERRORPRINTF("Sending keypress....");
    XSendEvent(xev.display, window, 1, KeyPressMask, (XEvent *) & xev);

    // We check to see if this is the UP key
    // so we don't send the release event for that, because it
    // can crash the contentLister with a BadWindow error (req.code 25)
    if ( keysym == GDK_F5 )
    {
        CL_ERRORPRINTF("NOT Sending keyrelease for UP key....");
    }
    else
    {
//        usleep(2000); // MvdW: this usleep doesn't seem to be nescessary
        xev.type = KeyRelease;
        xev.time = pm_fake_timestamp();
        XSendEvent(xev.display, window, 1, KeyReleaseMask, (XEvent *) & xev);
    }

    //XSync(xev.display, 1);
    XSync(xev.display, FALSE);

    if (window == g_myWin)
    {
        CL_PMPRINTF("Before XCloseDisplay()");
        XCloseDisplay(display);
    }
}

Here is the call graph for this function:

void pm_SetMyWindow

(

Window

window

)

set my own window ID

Parameters:

window

- window of the contentLister application

Definition at line 157 of file programManager.c.

{
    g_myWin = window;
}

void pm_setUaOnTop

(

char *

uaID

)

Sets the uaID of the user application that has just been started, and therefore is on top of the window stack now.

Parameters:

uaID

- user application identifier as specified in the registry