Beta version of xine_health_check. Double check XV detection function.

CVS patchset: 3137
CVS date: 2002/11/02 02:59:44

1 files changed, 265 insertions, 225 deletions

diff --git a/src/xine-utils/xine_check.c b/src/xine-utils/xine_check.c
index 89e782a1d..cf867d910 100644
--- a/src/xine-utils/xine_check.c
+++ b/src/xine-utils/xine_check.c
@@ -1,6 +1,42 @@
+/*
+* Copyright (C) 2000-2002 the xine project
+*
+* This file is part of xine, a free video player.
+*
+* xine is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+* (at your option) any later version.
+*
+* xine is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
+*
+* Xine Health Check:
+* 
+* Overview: Checking the setup of the user's system is the task of
+* xine-check.sh for now. At present this is intended to replace 
+* xine_check to provide a more robust way of informing users new
+* to xine of the setup of their system.
+*
+* Interface: The function xine_health_check is the starting point
+* to check the user's system. It is expected that the values for
+* hc->cdrom_dev and hc->dvd_dev will be defined. For example,
+* hc->cdrom_dev = /dev/cdrom and hc->/dev/dvd. If at any point a
+* step fails the entire process returns with a failed status, 
+* XINE_HEALTH_CHECK_FAIL, and an error message contained in hc->msg.
+*
+* Author: Stephen Torri <storri@users.sourceforge.net>
+*/
 #include "xine_check.h"
-#include <stdio.h>
 #include "xineutils.h"
+#include <X11/Xlib.h>
+#include <X11/extensions/Xvlib.h>
 #include <sys/stat.h>
 #include <sys/ioctl.h>
 #include <sys/utsname.h>
@@ -12,263 +48,267 @@
 #include <linux/major.h>
 #include <linux/hdreg.h>
 
-typedef struct {
-  FILE    *fd;
-  char    *filename;
-  char    *ln;
-  char     buf[256];
-} file_info_t;
-
-int xine_health_check(char* cdrom_dev, char* dvd_dev)
-{
-	int retval = 0;
+xine_health_check_t*
+xine_health_check (xine_health_check_t* hc) {
 
 #if 0
-	if (xine_health_check_os() < 0)
-	{
-		retval = -1;
-	}
+  if (xine_health_check_os() < 0) {
+    retval = -1;
+  }
 #endif
 
-	if (xine_health_check_kernel() < 0)
-	{
-		retval = -1;
-	}
+  hc = xine_health_check_kernel (hc);
+  if (hc->status == XINE_HEALTH_CHECK_FAIL) {
+    return hc;
+  }
 
 #if ARCH_X86
-	if (xine_health_check_mtrr() < 0)
-	{
-		retval = -1;
-	}
+  hc = xine_health_check_mtrr (hc);
+  if (hc->status == XINE_HEALTH_CHECK_FAIL) {
+    return hc;
+  }
 #endif /* ARCH_X86 */
 
-	if (xine_health_check_cdrom(cdrom_dev) < 0)
-	{
-		retval = -1;
-	}
+  hc = xine_health_check_cdrom (hc);
+  if (hc->status == XINE_HEALTH_CHECK_FAIL) {
+    return hc;
+  }
 
-	if (xine_health_check_dvdrom(dvd_dev) < 0)
-	{
-		retval = -1;
-	}
+  hc = xine_health_check_dvdrom (hc);
+  if (hc->status == XINE_HEALTH_CHECK_FAIL) {
+    return hc;
+  }
 
-	if (xine_health_check_dma(dvd_dev) < 0)
-	{
-		retval = -1;
-	}
+  hc = xine_health_check_dma (hc);
+  if (hc->status == XINE_HEALTH_CHECK_FAIL) {
+    return hc;
+  }
 
-	if (xine_health_check_x() < 0)
-	{
-		retval = -1;
-	}
+  hc = xine_health_check_x (hc);
+  if (hc->status == XINE_HEALTH_CHECK_FAIL) {
+    return hc;
+  }
 
-	if (xine_health_check_xv() < 0)
-	{
-		retval = -1;
-	}
+  hc = xine_health_check_xv (hc);
 
-	return retval;
+  return hc;
 }
 
-int xine_health_check_os(void)
+int
+xine_health_check_os(void)
 {
-	int retval = 0;
-	fprintf(stdout, "xine health_check (OS): ");
-
-	return retval;
+  return 0;
 }
 
-int xine_health_check_kernel(void)
-{
-	struct utsname kernel;
-
-	fprintf(stdout, "xine health_check (Kernel):\n");
-
-	if (uname(&kernel) == 0)
-	{
-		fprintf(stdout,"  sysname: %s\n", kernel.sysname);
-		fprintf(stdout,"  release: %s\n", kernel.release);
-		fprintf(stdout,"  machine: %s\n", kernel.machine);
-	}
-	else
-	{
-		fprintf(stdout,"  FAILURE - Could not get kernel information.\n");
-		return -1;
-	}
-	return 0;
+xine_health_check_t*
+xine_health_check_kernel (xine_health_check_t* hc) {
+  struct utsname kernel;
+
+  if (uname (&kernel) == 0) {
+    fprintf (stdout,"  sysname: %s\n", kernel.sysname);
+    fprintf (stdout,"  release: %s\n", kernel.release);
+    fprintf (stdout,"  machine: %s\n", kernel.machine);
+    hc->status = XINE_HEALTH_CHECK_OK;
+  }
+  else {
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+    hc->msg =  "FAILED - Could not get kernel information.";
+  }
+  return hc;
 }
 
-int xine_health_check_mtrr(void)
-{
-	char *file = "/proc/mtrr";
-	FILE *fd;
-
-	fprintf(stdout, "xine health_check (MTRR):\n");
-
-	fd = fopen(file, "r");
-	if (fd < 0)
-	{
-		fprintf(stdout, "  FAILED: mtrr is not enabled.\n");
-		return -1;
-	}
-	else {
-		fprintf(stdout, "  SUCCESS: mtrr is enabled.\n");
-		fclose(fd);
-	}
-	return 0;
+xine_health_check_t*
+xine_health_check_mtrr (xine_health_check_t* hc) {
+  char *file = "/proc/mtrr";
+  FILE *fd;
+
+  fd = fopen(file, "r");
+  if (fd < 0) {
+    hc->msg = "FAILED: mtrr is not enabled.";
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+  }
+  else {
+    hc->status = XINE_HEALTH_CHECK_OK;
+    fclose (fd);
+  }
+  return hc;
 }
 
-int xine_health_check_cdrom(char* cdrom_dev)
-{
-	struct stat cdrom_st;
-
-	fprintf(stdout, "xine health_check (CDROM):\n");
-
-	if (stat(cdrom_dev,&cdrom_st) < 0)
-	{
-		fprintf(stdout, "  FAILED - could not cdrom: %s.\n", cdrom_dev);
-		return -1;
-	}
-	else
-	{
-		fprintf(stdout, "  SUCCESS - cdrom link %s is present.\n",cdrom_dev);
-	}
-
-	if ((cdrom_st.st_mode & S_IFMT) != S_IFBLK)
-	{
-		fprintf(stdout, "  FAILED - %s is not a block device.\n", cdrom_dev);
-		return -1;
-	}
-	else
-	{
-		fprintf(stdout, "  SUCCESS - %s is a block device.\n", cdrom_dev);
-	}
-
-	if ((cdrom_st.st_mode & S_IFMT & S_IRWXU & S_IRWXG & S_IRWXO) != (S_IRUSR & S_IXUSR & S_IRGRP & S_IXGRP & S_IROTH & S_IXOTH))
-	{
-		fprintf(stdout, "  FAILED - %s permissions are not 'rwxrwxrx'.\n",cdrom_dev);
-	}
-	else {
-		fprintf(stdout, "  SUCCESS - %s does have proper permission.\n",cdrom_dev);
-	}
-
-	return 0;
+xine_health_check_t*
+xine_health_check_cdrom (xine_health_check_t* hc) {
+  struct stat cdrom_st;
+
+  if (stat (hc->cdrom_dev,&cdrom_st) < 0) {
+    hc->msg = (char*) malloc(sizeof(char)*(30-2) + strlen(hc->cdrom_dev + 1));
+    sprintf (hc->msg, "FAILED - could not cdrom: %s\n", hc->cdrom_dev);
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+  }
+  else {
+    if ((cdrom_st.st_mode & S_IFMT) != S_IFBLK) {
+      hc->msg = (char*) malloc(sizeof(char)*(36-2) + strlen(hc->cdrom_dev) + 1);
+      sprintf(hc->msg, "FAILED - %s is not a block device.\n", hc->cdrom_dev);
+      hc->status = XINE_HEALTH_CHECK_FAIL;
+      return hc;
+    }
+
+    if ((cdrom_st.st_mode & S_IFMT & S_IRWXU & S_IRWXG & S_IRWXO) !=
+        (S_IRUSR & S_IXUSR & S_IRGRP & S_IXGRP & S_IROTH & S_IXOTH)) {
+      hc->msg = (char*) malloc(sizeof(char)*(43-2) + strlen(hc->cdrom_dev) + 1);
+      sprintf(hc->msg, "FAILED - %s permissions are not 'rwxrwxrx'\n.", hc->cdrom_dev);
+      hc->status = XINE_HEALTH_CHECK_FAIL;
+      return hc;
+    }
+    hc->status = XINE_HEALTH_CHECK_OK;
+  }
+  return hc;
 }
 
-int xine_health_check_dvdrom(char* dvd_dev)
-{
-	struct stat dvdrom_st;
-
-	fprintf(stdout, "xine health_check (DVDROM):\n");
-
-	if (stat(dvd_dev,&dvdrom_st) < 0)
-	{
-		fprintf(stdout, "  FAILED - could not dvdrom: %s.\n", dvd_dev);
-		return -1;
-	}
-	else
-	{
-		fprintf(stdout, "  SUCCESS - dvdrom link %s is present.\n",dvd_dev);
-	}
-
-	if ((dvdrom_st.st_mode & S_IFMT) != S_IFBLK)
-	{
-		fprintf(stdout, "  FAILED - %s is not a block device.\n", dvd_dev);
-		return -1;
-	}
-	else
-	{
-		fprintf(stdout, "  SUCCESS - %s is a block device.\n", dvd_dev);
-	}
-
-	if ((dvdrom_st.st_mode & S_IFMT & S_IRWXU & S_IRWXG & S_IRWXO) != (S_IRUSR & S_IXUSR & S_IRGRP & S_IXGRP & S_IROTH & S_IXOTH))
-	{
-		fprintf(stdout, "  FAILED - %s permissions are not 'rwxrwxrx'.\n",dvd_dev);
-	}
-	else {
-		fprintf(stdout, "  SUCCESS - %s does have proper permission.\n",dvd_dev);
-	}
-
-	return 0;
+xine_health_check_t*
+xine_health_check_dvdrom(xine_health_check_t* hc) {
+
+  struct stat dvdrom_st;
+
+  if (stat (hc->dvd_dev,&dvdrom_st) < 0) {
+    hc->msg = (char*) malloc(sizeof(char)*(30-2) + strlen(hc->dvd_dev + 1));
+    sprintf(hc->msg, "FAILED - could not dvdrom: %s\n", hc->dvd_dev);
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+    return hc;
+  }
+
+  if ((dvdrom_st.st_mode & S_IFMT) != S_IFBLK) {
+    hc->msg = (char*) malloc(sizeof(char)*(36-2) + strlen(hc->dvd_dev) + 1);
+    sprintf (hc->msg, "FAILED - %s is not a block device.\n", hc->dvd_dev);
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+    return hc;
+  }
+
+  if ((dvdrom_st.st_mode & S_IFMT & S_IRWXU & S_IRWXG & S_IRWXO) !=
+      (S_IRUSR & S_IXUSR & S_IRGRP & S_IXGRP & S_IROTH & S_IXOTH)) {
+    hc->msg = (char*) malloc(sizeof(char)*(43-2) + strlen(hc->cdrom_dev) + 1);
+    sprintf(hc->msg, "FAILED - %s permissions are not 'rwxrwxrx'.\n", hc->dvd_dev);
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+    return hc;
+  }
+
+  hc->status = XINE_HEALTH_CHECK_OK;
+  return hc;
 }
 
-int xine_health_check_dma(char* dvd_dev)
-{
-	int retval = 0;
-	int is_scsi_dev = 0;
-	int fd = 0;
-	static long param = 0;
-	struct stat st;
-
-	fprintf(stdout, "xine health_check (DMA):\n");
-
-	/* If /dev/dvd points to /dev/scd0 but the drive is IDE (e.g. /dev/hdc) and not scsi 
-	 * how do we detect the correct one */
-	if (stat(dvd_dev, &st)){
-		perror(dvd_dev);
-		exit(errno);
-	}
-
-	if (major(st.st_rdev) == LVM_BLK_MAJOR){
-		is_scsi_dev = 1;
-		fprintf(stdout, "  SKIPPED - Operation not supported on SCSI drives or drives that use the ide-scsi module.\n");
-	}
-
-	/* At this time due to the way my system is setup user 'root' must be runnning xine */
-	fd = open(dvd_dev, O_RDONLY | O_NONBLOCK);
-	if (fd < 0)
-	{
-		perror(dvd_dev);
-		exit(errno);
-	}
-
-	if (!is_scsi_dev){
-		if(ioctl(fd, HDIO_GET_DMA, &param))
-		{
-			fprintf(stdout, "  FAILED -  HDIO_GET_DMA failed. Ensure the permissions for %s are 0664.\n", dvd_dev);
-		}
-		if (param != 1)
-		{
-			fprintf(stdout, "  FAILED - DMA not turned on for %s.\n", dvd_dev);
-		}
-		else
-		{
-			fprintf(stdout, "  SUCCESS - DMA turned on for %s.\n", dvd_dev);
-			close(fd);
-		}
-	}
-
-	return retval;
+xine_health_check_t*
+xine_health_check_dma (xine_health_check_t* hc) {
+
+  int is_scsi_dev = 0;
+  int fd = 0;
+  static long param = 0;
+  struct stat st;
+
+  /* If /dev/dvd points to /dev/scd0 but the drive is IDE (e.g. /dev/hdc)
+   * and not scsi how do we detect the correct one */
+  if (stat (hc->dvd_dev, &st)) {
+    hc->msg = (char*) malloc (sizeof (char) * (39-2) + strlen(hc->dvd_dev) + 1);
+    sprintf(hc->msg, "FAILED - Could not read stats for %s.\n", hc->dvd_dev);
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+    return hc;
+  }
+
+  if (major (st.st_rdev) == LVM_BLK_MAJOR) {
+    is_scsi_dev = 1;
+    hc->msg = "SKIPPED - Operation not supported on SCSI drives or drives that use the ide-scsi module.";
+    hc->status = XINE_HEALTH_CHECK_OK;
+    return hc;
+  }
+
+  fd = open (hc->dvd_dev, O_RDONLY | O_NONBLOCK);
+  if (fd < 0) {
+    hc->msg = (char*) malloc (sizeof (char) * 80);
+    sprintf(hc->msg, "FAILED - Could not open %s.\n", hc->dvd_dev);
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+    return hc;
+  }
+
+  if (!is_scsi_dev) {
+
+    if(ioctl (fd, HDIO_GET_DMA, &param)) {
+      hc->msg = (char*) malloc (sizeof (char) * (71-2) + strlen(hc->dvd_dev) + 1);
+      sprintf(hc->msg,
+          "FAILED -  HDIO_GET_DMA failed. Ensure the permissions for %s are 0664.\n",
+          hc->dvd_dev);
+      hc->status = XINE_HEALTH_CHECK_FAIL;
+      return hc;
+    }
+
+    if (param != 1) {
+      char* instructions = "If you are using the ide-cd module ensure \
+        that you have the following entry in /etc/modules.conf:\n \
+        options ide-cd dma=1\n Reload ide-cd module.";
+      hc->msg = (char*) malloc (sizeof (char) * (39-2) +
+          strlen(hc->dvd_dev) + strlen(instructions) + 1);
+      sprintf(hc->msg, "FAILED - DMA not turned on for %s.\n%s\n", hc->dvd_dev, instructions);
+      hc->status = XINE_HEALTH_CHECK_FAIL;
+      return hc;
+    }
+  }
+  close (fd);
+  hc->status = XINE_HEALTH_CHECK_OK;
+  return hc;
 }
 
-int xine_health_check_x(void)
-{
-	char* env_display = getenv("DISPLAY");
-
-	fprintf(stdout, "xine health_check (X):\n");
-	if (strlen(env_display) == 0)
-	{
-		fprintf(stdout, "  FAILED - DISPLAY environment variable not set.\n");
-		return -1;
-	}
-	else
-	{
-		fprintf(stdout, "  SUCCESS - DISPLAY environment variable is set.\n");
-	}
-	return 0;
-}
 
-int xine_health_check_xv(void)
-{
-	int retval = 0;
+xine_health_check_t*
+xine_health_check_x (xine_health_check_t* hc) {
+  char* env_display = getenv("DISPLAY");
 
-	fprintf(stdout, "xine health_check (XV):\n");
+  if (strlen (env_display) == 0) {
+    hc->msg = "FAILED - DISPLAY environment variable not set.";
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+  }
+  else {
+    hc->status = XINE_HEALTH_CHECK_OK;
+  }
+  return hc;
+}
 
-	return retval;
+xine_health_check_t*
+xine_health_check_xv (xine_health_check_t* hc) {
+
+  Display *dpy;
+  unsigned int ver, rev, eventB, reqB, errorB;
+  char * disname = NULL;
+
+  /* Majority of thi code was taken from or inspired by the xvinfo.c file of XFree86 */
+  if(!(dpy = XOpenDisplay(disname))) {
+    char* display_name = "";
+    if (disname != NULL) {
+      display_name = disname;
+    }
+    else {
+      display_name = XDisplayName(NULL);
+    }
+    hc->msg = (char*) malloc (sizeof (char) * (28-2) + strlen(display_name) + 1);
+    sprintf(hc->msg, "Unable to open display: %s\n", display_name);
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+    return hc;
+  }
+
+  if((Success != XvQueryExtension(dpy, &ver, &rev, &reqB, &eventB, &errorB))) {
+    hc->msg = (char*) malloc (sizeof (char) * 80);
+    sprintf(hc->msg, "No X-Video Extension on %s", (disname != NULL) ? disname : XDisplayName(NULL));
+    hc->status = XINE_HEALTH_CHECK_FAIL;
+  }
+  else {
+    hc->msg = (char*) malloc (sizeof (char) * (33-4) + sizeof(unsigned int) * 2 + 1);
+    sprintf(hc->msg, "X-Video Extension version %d.%d\n", ver , rev);
+    hc->status = XINE_HEALTH_CHECK_OK;
+  }
+  return hc;
 }
+
 #else	/* !__linux__ */
-int xine_health_check(char* cdrom_dev, char* dvd_dev)
+xine_health_check_t*
+xine_health_check (xine_health_check_t* hc)
 {
-	return 0;
+  hc->status = XINE_HEALTH_CHECK_UNSUPPORTED;
+  hc->msg = "Xine health check not supported on the OS.\n";
+  return hc;
 }
 #endif	/* !__linux__ */