Attachment #155034 for bug #198799




# $FreeBSD: head/sysutils/bsdstats/Makefile 339133 2014-01-08 13:53:59Z lme $

PORTNAME=	bsdstats
PORTVERSION=	6.0
PORTREVISION=	5
CATEGORIES=	sysutils
DISTFILES=

MAINTAINER=	yuri@rawbw.com
COMMENT=	Monthly script for reporting anonymous statistics about your machine

LICENSE=	BSD4CLAUSE

NO_BUILD=	yes
USE_RC_SUBR=	bsdstats
SUB_FILES=	300.statistics bsdstats-update pkg-message
SUB_LIST+=	VERSION=${PORTVERSION}
NO_ARCH=	YES

OPTIONS_DEFINE=	TOR
TOR_DESC=	Submit securely through Tor anonymity network

.include <bsd.port.pre.mk>

.if ${PORT_OPTIONS:MTOR}
RUN_DEPENDS+=	tor:${PORTSDIR}/security/tor
.endif

pre-install:
.if ${PORT_OPTIONS:MTOR}
	@${REINPLACE_CMD} -e 's|USE_TOR=NO|USE_TOR=YES|' ${WRKDIR}/300.statistics
	@${REINPLACE_CMD} -e 's|# REQUIRE: LOGIN|# REQUIRE: LOGIN tor|' ${WRKDIR}/bsdstats
	@${REINPLACE_CMD} -e 's|@@TOR_MESSAGE@@|Statistics will be submitted anonymously through the TOR network|' \
	    ${WRKDIR}/pkg-message
.else
	@${REINPLACE_CMD} -e 's|@@TOR_MESSAGE@@|You can build bsdstats with TOR port option to submit anonymously|' \
	    ${WRKDIR}/pkg-message
.endif

do-install:
	${MKDIR} ${STAGEDIR}${PREFIX}/etc/periodic/monthly
	${INSTALL_SCRIPT} ${WRKDIR}/300.statistics \
		${STAGEDIR}${PREFIX}/etc/periodic/monthly
	${INSTALL_SCRIPT} ${WRKDIR}/bsdstats-update \
		${STAGEDIR}${PREFIX}/bin/bsdstats-update
.if ! defined(BATCH) && ! defined(PACKAGE_BUILDING)
	@PKG_PREFIX="${PREFIX}" ${SH} ${PKGINSTALL} ${PKGNAME} POST-INSTALL
.endif

.include <bsd.port.post.mk>




# $FreeBSD: /tmp/pcvs/ports/sysutils/bsdstats/files/300.statistics.in,v 1.45 2011-09-25 21:35:26 eadler Exp $
#

#
# options
#
CURR_VERSION="%%VERSION%%"
USE_TOR=NO

#
# Standard commands used here
#
PCICONF=/usr/sbin/pciconf
OPENSSL=/usr/bin/openssl
CHOWN=/usr/sbin/chown
UNAME=/usr/bin/uname
UMASK=/usr/bin/umask
SYSCTL=/sbin/sysctl
AWK=/usr/bin/awk
SED=/usr/bin/sed
CUT=/usr/bin/cut
JOT=/usr/bin/jot
SLEEP=/bin/sleep
CHMOD=/bin/chmod
NC=/usr/bin/nc
WC=/usr/bin/wc
MV=/bin/mv
RM=/bin/rm

#
# constants
#
CR=$'\r'
NL=$'\n'

#
# If there is a global system configuration file, suck it in.
#
if [ -r /etc/defaults/periodic.conf ]; then
  . /etc/defaults/periodic.conf
  source_periodic_confs
  periodic_conf=/etc/periodic.conf
    periodic_conf=/etc/periodic.conf
else
  . /etc/rc.conf  # For systems without periodic.conf, use rc.conf
  if [ -r /etc/rc.conf.local ]; then
    . /etc/rc.conf.local
  fi
  periodic_conf=/etc/rc.conf.local
    periodic_conf=/etc/rc.conf.local
fi

#
# global values
#

version="5.5"
checkin_server=${monthly_statistics_checkin_server:-"rpt.bsdstats.org"}
bsdstats_log=${monthly_statistics_logfile:-"/var/log/bsdstats"}
id_token_file='/var/db/bsdstats'
checkin_server_description=${checkin_server}
nc_host=${checkin_server}
nc_port=80
http_header_proxy_auth=""


oldmask=$(${UMASK})
${UMASK} 066
timeout=10

##
## Procedures
##

echo_begin() {
  echo -n "$1 ... "
}

echo_end_success() {
  echo "SUCCESS"
}

echo_err() {
  echo "$1" >&2
}

log() { # log(categ,msg)
  echo "[`date "+%Y-%m-%d %H:%M:%S"`] $1 $2" >> $bsdstats_log
}

fail() { # fail(msg): argument is simple user-level message, detailed log message is assumed to be printed before 'fail' invokation
  # log error
  log "TERM" "$1 (failure)"
  # let user know
  echo_err "BSDstats failed: $1"
  # bail out
  ${UMASK} $oldmask
  exit 1
}

random() {
  ${JOT} -r 1 0 900
}

# do_http_request: if success returns 0, and prints http.body, otherwise returns 1
do_http_request() {
  local meth="$1"
  local url="$2"
  local body="$3"
  local content_type="$4"
  local do_log="$5"

  local resp
  local lineno
  local in_header
  local result_count

  if [ -n "${http_header_proxy_auth}" ]; then url="http://${checkin_server}${url}"; fi

  local txt="${meth} ${url} HTTP/1.0"
  local http_req="${txt}"
  txt="${txt}${CR}${NL}Host: ${checkin_server}"
  if [ -n "${http_header_proxy_auth}" ]; then txt="${txt}${CR}${NL}Proxy-Authorization: ${http_header_proxy_auth}"; fi
  txt="${txt}${CR}${NL}User-Agent: bsdstats-${CURR_VERSION}"
  txt="${txt}${CR}${NL}Connection: close"
  if [ -n "${content_type}" ]; then txt="${txt}${NL}Content-Type: ${content_type}"; fi
  if [ -n "${body}" ]; then txt="${txt}${CR}${NL}Content-Length: ${#body}"; fi
  txt="${txt}${CR}${NL}${CR}${NL}${body}"

  resp=$(echo "${txt}" | ${NC} ${nc_host} ${nc_port} 2>/dev/null)
  if [ $? -ne 0 ]; then
    if [ ${do_log} -ne 0 ]; then
      log "FAIL" "Failed to send data to the host ${nc_host}:${nc_port}, is network or host down?"
    fi
    return 1
  fi

  local IFS=${NL}${CR}
  lineno=0
  in_header=1
  http_result=""
  for str in ${resp}; do
    if [ $lineno -eq 0 ] ; then
      if expr "${str}" : "^HTTP/1\.[01] 200 OK$" > /dev/null; then
        # ok
        true
      else
        if [ ${do_log} -ne 0 ]; then
          log "FAIL" "Failed HTTP query: request='${http_req}' -> response='${str}'"
        fi
        return 2
      fi
    elif [ $lineno -ge 1 -a $in_header -eq 1 ] ; then
      if [ -z "${str}" ]; then
        in_header=0
        result_count=0
      fi
    else
      if [ $result_count -eq 0 ]; then
        http_result="${str}"
      else
        http_result="${http_result}${NL}${str}"
	        category=`pkg info -q -o ${line} | sed 's/\/.*//g'`
	        line=$(uri_escape $line)
	        category=$(uri_escape $category)
	        query_string=$query_string`echo \&port[]=${category}:${line}`
	      done

	    else

	      # Use pkg_* tools

	      for line in `pkg_info | awk '{ print $1 }'`
	      do
	        category=`grep "@comment ORIGIN" /var/db/pkg/${line}/+CONTENTS | sed -E 's/^\@comment ORIGIN:(.+)\/.+/\1/g'`
	        line=$(uri_escape $line)
	        category=$(uri_escape $category)
	        query_string=$query_string`echo \&port[]=${category}:${line}`
	      done

	    fi
	#-----END LEGACY-----
	#
	# 2. Uncomment the contents of this "PKGNG" section:
	#
	#-----BEGIN PKGNG-----
#	    for line in `pkg info | awk '{ print $1 }'`
#	    do
#	       category=`pkg info -q -o ${line} | sed 's/\/.*//g'`
#	       line=$(uri_escape $line)
#	       category=$(uri_escape $category)
#	      query_string=$query_string`echo \&port[]=${category}:${line}`
#	    done
	#-----END PKGNG-----
	#
	# 3. Delete these comments.
	#
	# Thank you!
	############################################################################

	    report_ports
	    ;;
	* )
	    # Not supported
	    ;;
    esac
}

report_ports () {
	# Handle HTTP proxy services
	#
	# HTTP_PROXY/http_proxy can take the following form:
	#    [http://][username:password@]proxy[:port][/]
	# Authentication details may also be provided via HTTP_PROXY_AUTH:
	#    HTTP_PROXY_AUTH="basic:*:username:password"
	#

	if [ -z "$HTTP_PROXY" -a -n "$http_proxy" ]; then
		HTTP_PROXY=$http_proxy
	fi
	if [ -n "$HTTP_PROXY" ]; then
		# Attempt to resolve any HTTP authentication
		if [ -n "$HTTP_PROXY_AUTH" ]; then
			PROXY_AUTH_USER=`echo $HTTP_PROXY_AUTH | sed -E 's/^.+:\*:(.+):.+$/\1/g'`
			PROXY_AUTH_PASS=`echo $HTTP_PROXY_AUTH | sed -E 's/^.+:\*:.+:(.+)$/\1/g'`
		else
			# Check for authentication within HTTP_PROXY
			HAS_HTTP_AUTH=`echo $HTTP_PROXY | sed -E 's/^(http:\/\/)?(.+:.+@)?.+/\2/'`
			if [ -n "$HAS_HTTP_AUTH" ]; then
				# Found HTTP authentication details
				PROXY_AUTH_USER=`echo $HAS_HTTP_AUTH | cut -d: -f1`
				PROXY_AUTH_PASS=`echo $HAS_HTTP_AUTH | cut -d: -f2`
			fi
		fi

		# Determine the proxy components
		PROXY_HOST=`echo $HTTP_PROXY | sed -E 's/^(http:\/\/)?(.+:.+@)?([^@:]+)(:.+)?/\3/'`
		PROXY_PORT=`echo $HTTP_PROXY | sed -E 's/^(http:\/\/)?(.+:.+@)?(.+):([0-9]+)/\4/' | sed -e 's/[^0-9]//g'`
		if [ -z "$PROXY_PORT" ]; then
			# Use default proxy port
			PROXY_PORT=3128
		fi
	fi

	# Determine the host/port netcat should connect to
	if [ -n "$PROXY_HOST" -a -n "$PROXY_PORT" ]; then
		nc_host=$PROXY_HOST
		nc_port=$PROXY_PORT
		url_prefix="http://${checkin_server}"
	else
		nc_host=$checkin_server
		nc_port=80
	fi

	# Proxy authentication, if required
	if [ -n "$PROXY_AUTH_USER" -a -n "$PROXY_AUTH_PASS" ]; then
		auth_base64=`echo "$PROXY_AUTH_USER:$PROXY_AUTH_PASS" | openssl base64`
		proxy_auth="Proxy-Authorization: Basic $auth_base64
"
	fi


	# Make the request	
	string_length=`echo ${query_string} | wc -m` 
	string_length=$((string_length - 1))

	echo "POST ${url_prefix}/scripts/report_ports.php HTTP/1.0
Host: ${checkin_server}
User-Agent: bsdstats ${version}
Connection: close
${proxy_auth}Content-Type: application/x-www-form-urlencoded
Content-Length: ${string_length}

token=${TOKEN}&key=${KEY}${query_string}" | \
		nc $nc_host $nc_port  | \
		grep STATUS= | {
          local IFS
          IFS='= 
'

           while read var val
             do  
             case $var in
                 STATUS)
                     if [ $val = "OK" ]
                     then
                       echo "[`date`] System Ports reported"
                     else
                       echo "[`date`] System Ports not reported, exiting"
                       exit
                     fi
                 ;; 
                 *)
                     echo "[`date`] Error with fetch to server"
                     exit
                 ;;
                 esac
           done   
       } >> $bsdstats_log

}

report_devices () {
      do_fetch report_devices.php?token=$TOKEN\&key=$KEY$query_string | { 
          local IFS
          IFS='=
'

           while read var val
             do
             case $var in
                 STATUS)
                     if [ $val = "OK" ]
                     then
                       echo "[`date`] System Devices reported"
                     else
                       echo "[`date`] System Devices not reported, exiting"
                       exit
                     fi
                 ;;
                 *)
                     echo "[`date`] Error with fetch to server"
                     exit
                 ;;
                 esac
           done  
       } >> $bsdstats_log
}

get_id_token () {
    if [ -f $id_token_file ]
    then
      if [ `wc -l < $id_token_file` -lt 3 ] 
      then
        rm $id_token_file
      fi
      result_count=$(($result_count+1))
    fi
    lineno=$(($lineno+1))
  done
  echo "${http_result}"
  return 0
}

extract_field() {
  # charset of the value, besides alnum covers base64 encoding charset (/+), and single quote
  echo "$1" | grep "^${2}=" | tail -1 | sed -E -e "s/^${2}=([a-zA-Z0-9=/+']+).*/\1/g"
}

do_http_request_check_status() {
  local body
  local status
  local what="$5"
  # run request
  body=$(do_http_request "$1" "$2" "$3" "$4" 1)
  if [ $? -ne 0 ]; then
    fail "HTTP query failed during ${what}"
  fi
  # check status
  status=$(extract_field "${body}" "STATUS")
  case "${status}" in
    OK)
      # pass
      true
      ;;
    FAIL)
      log "FAIL" "Got STATUS=FAIL from the server in during ${what}"
      fail "${what} request failed"
      ;;
    *)
      fail "Server didn't return the status for ${what}"
      ;;
  esac
}

uri_escape() {
  # RFC 2396
  echo "${1+$@}" | ${SED} -e '
    s/%/%25/g
    s/;/%3b/g
    s,/,%2f,g
    s/?/%3f/g
    s/:/%3a/g
    s/@/%40/g
    s/&/%26/g
    s/=/%3d/g
    s/+/%2b/g
    s/\$/%24/g
    s/,/%2c/g
    s/ /%20/g
    '
		 KEY)
                     echo "KEY=$val"
		 ;;
		 TOKEN)
                     echo "TOKEN=$val"
		 ;;
		 *)
                 ;;
		 esac
	   done
           echo "VERSION=$version"
       } > $idf                                  && \

       mv $idf $id_token_file
       if [ ! -s $id_token_file ] ;
       then
    	  echo "Nothing returned from $checkin_server"
	  exit 1
       fi
    fi
    . $id_token_file
    KEY=$( uri_escape $KEY )
    TOKEN=$( uri_escape $TOKEN )
}


enable_token () {
      do_fetch enable_token.php?key=$TOKEN\&token=$KEY | {
          local IFS
          IFS='=
'

           while read var val
             do
             case $var in
                 STATUS)
                     if [ $val = "OK" ]
                     then
                       echo "[`date`] System enabled"
                     else
                       echo "[`date`] System not enabled, exiting"
                       exit
                     fi
                 ;;
                 *)
                     echo "[`date`] Error with fetch to server"
                     exit
                 ;;
                 esac
           done  
       } >> $bsdstats_log
}

disable_token () {
      do_fetch disable_token.php?key=$TOKEN\&token=$KEY | {
          local IFS
          IFS='=
'

           while read var val
             do
             case $var in
                 STATUS)
                     if [ $val = "OK" ]
                     then
                       echo "[`date`] System disabled"
                     else
                       echo "[`date`] System not disabled, exiting"
                       exit
                     fi
                 ;;
                 *)
                     echo "[`date`] Error with fetch to server"
                     exit
                 ;;
                 esac
           done  
       } >> $bsdstats_log
}

report_system () {
      do_fetch report_system.php?token=$TOKEN\&key=$KEY\&rel=$REL\&arch=$ARCH\&opsys=$OS | {
          local IFS
          IFS='=
'

           while read var val
             do
             case $var in
                 STATUS)
                     if [ $val = "OK" ]
                     then
                       echo "[`date`] System reported"
                     else
                       echo "[`date`] System report failed, exiting"
                       exit
                     fi
                 ;;
                 *)
                     echo "[`date`] Error with fetch to server"
                     exit
                 ;;
                 esac
           done  
       } >> $bsdstats_log
}

report_cpu () {
    do_fetch report_cpu.php?token=$TOKEN\&key=$KEY\&cpus=$count\&vendor=$VEN\&cpu_type=$DEV | {
          local IFS
          IFS='=
'

           while read var val
             do
             case $var in
                 STATUS)
                     if [ $val = "OK" ]
                     then
                       echo "[`date`] System CPU reported"
                     else
                       echo "[`date`] System CPU report failed, exiting"
                       exit
                     fi
                 ;;
                 *)
                     echo "[`date`] Error with fetch to server"
                     exit
                 ;;
                 esac
           done  
       } >> $bsdstats_log
}

parse_http_proxy_string() {
# Handle HTTP proxy services
#
# HTTP_PROXY/http_proxy can take the following form:
#    [http://][username:password@]proxy[:port][/]
# Authentication details may also be provided via HTTP_PROXY_AUTH:
#    HTTP_PROXY_AUTH="basic:*:username:password"
#
# IN:   * HTTP_PROXY or http_proxy
# IN:   * HTTP_PROXY_AUTH
# OUT:  * http_header_proxy_auth
# OUT:  * nc_host
# OUT:  * nc_port

  local PROXY_AUTH_USER
  local PROXY_AUTH_PASS
  local PROXY_HOST
  local PROXY_PORT

  if [ -z "$HTTP_PROXY" -a -n "$http_proxy" ]; then
    HTTP_PROXY=$http_proxy
  fi
  if [ -n "$HTTP_PROXY" ]; then
    # Attempt to resolve any HTTP authentication
    if [ -n "$HTTP_PROXY_AUTH" ]; then
      PROXY_AUTH_USER=$(echo $HTTP_PROXY_AUTH | ${SED} -E 's/^.+:\*:(.+):.+$/\1/g')
      PROXY_AUTH_PASS=$(echo $HTTP_PROXY_AUTH | ${SED} -E 's/^.+:\*:.+:(.+)$/\1/g')
    else
      # Check for authentication within HTTP_PROXY
      HAS_HTTP_AUTH=$(echo $HTTP_PROXY | ${SED} -E 's/^(http:\/\/)?((.+:.+)@)?.+/\3/')
      if [ -n "$HAS_HTTP_AUTH" ]; then
        # Found HTTP authentication details
        PROXY_AUTH_USER=$(echo $HAS_HTTP_AUTH | ${CUT} -d: -f1)
        PROXY_AUTH_PASS=$(echo $HAS_HTTP_AUTH | ${CUT} -d: -f2)
                 echo "    set monthly_statistics_report_ports=\"YES\" in $periodic_conf"
                 ;;
          esac
      fi
    fi

    # Determine the proxy components
    PROXY_HOST=$(echo $HTTP_PROXY | ${SED} -E 's/^(http:\/\/)?(.+:.+@)?([^@:]+)(:.+)?/\3/')
    PROXY_PORT=$(echo $HTTP_PROXY | ${SED} -E 's/^(http:\/\/)?(.+:.+@)?(.+):([0-9]+)/\4/' | ${SED} -e 's/[^0-9]//g')
    if [ -z "$PROXY_PORT" ]; then
      # Use default proxy port
      PROXY_PORT=3128
    fi
  fi

  # Determine the host/port netcat should connect to
  if [ -n "$PROXY_HOST" -a -n "$PROXY_PORT" ]; then
    nc_host=$PROXY_HOST
    nc_port=$PROXY_PORT
    # Proxy authentication, if required
    if [ -n "$PROXY_AUTH_USER" -a -n "$PROXY_AUTH_PASS" ]; then
      local auth_base64=$(echo -n "$PROXY_AUTH_USER:$PROXY_AUTH_PASS" | ${OPENSSL} base64)
      http_header_proxy_auth="Basic $auth_base64"
    fi
    return 0
  else
    nc_host=$checkin_server
    nc_port=80
    return 1
  fi
}

test_connection() {
  local body
  body=$(do_http_request "HEAD" "/" "" "" 0)
  if [ $? -ne 0 -a $? -ne 2 ]; then
    log "FAIL" "Unable to connect to ${checkin_server_description}"
    fail "Network or host is down?"
  fi
}

setup_proxies() {
  # TOR
  if [ "${USE_TOR}" = "YES" ]; then
    if [ -n "${HTTP_PROXY}" -o -n "${http_proxy}" ]; then
      echo_err "Ignoring HTTP_PROXY since TOR is used"
    fi
    NC="${NC} -x localhost:9050 -X 5"
    checkin_server_description="${checkin_server_description} (through TOR)"
    return 0
  fi

  # HTTP proxy
  if [ -n "${HTTP_PROXY}" -o -n "${http_proxy}" ]; then
    parse_http_proxy_string
    if [ $? -eq 0 ]; then
      checkin_server_description="${checkin_server_description} (through proxy)"
      return 0
    fi
  fi

  # no proxy
}

report_devices() {
  case $(${UNAME}) in
    FreeBSD)
      local query_string=""
      local line
      for line in $(${PCICONF} -l); do
        local DRIVER=$(echo "${line}" | ${AWK} -F\@ '{print $1}')
        local DEV=$(echo "${line}" | ${AWK} '{print $4}' | ${CUT} -c8-15)
        local CLASS=$(echo "${line}" | ${AWK} '{print $2}' | ${CUT} -c9-14)
        query_string=$query_string`echo \&dev[]=${DRIVER}:${DEV}:${CLASS}`
      done

      echo_begin "Posting device statistics to ${checkin_server_description}"
      do_http_request_check_status "GET" "/scripts/report_devices.php?token=${TOKEN}&key=${KEY}$query_string" \
        "" "" "system devices sumbission"
      echo_end_success
      log "INFO" "System devices reported to ${checkin_server_description}"
      ;;
    *)
      # Not supported
      ;;
  esac
}

report_ports() {
  case $(${UNAME}) in
    FreeBSD)
      local query_string=""
      # Detect pkgng
      if [ -e /var/db/pkg/local.sqlite ]; then
        # Use pkgng
        query_string="${query_string}$(pkg info -o "*" | ${SED} -E -e 's/\+/%2b/g' -e 's/,/%2c/g' -e 's/^([^ ]+) +([^\/]+)\/.+$/\&port[]=\2:\1/g' | tr -d '\n')"
      else
    #-----BEGIN LEGACY: to delete when FreeBSD with pkg_ tools is out of support period-----
        # Use obsolete pkg_* tools
        local line
        for line in `pkg_info | ${AWK} '{ print $1 }'`; do
          local category=`grep "@comment ORIGIN" /var/db/pkg/${line}/+CONTENTS | ${SED} -E 's/^\@comment ORIGIN:(.+)\/.+/\1/g'`
          line=$(uri_escape $line)
          category=$(uri_escape $category)
          query_string=$query_string`echo \&port[]=${category}:${line}`
        done
    #-----END LEGACY-----
      fi
      echo_begin "Posting port statistics to ${checkin_server_description}"
      do_http_request_check_status "POST" "/scripts/report_ports.php" \
        "token=${TOKEN}&key=${KEY}${query_string}" "application/x-www-form-urlencoded" "ports sumbission"
      echo_end_success
      log "INFO" "Posted port statistics to ${checkin_server_description}"
      ;;
    *)
      # Not supported
      ;;
  esac
}

get_id_token() {
  if [ -f $id_token_file ]; then
    if [ $(${WC} -l < $id_token_file) -lt 3 ]; then
      ${RM} -f $id_token_file
    fi
  fi

  if [ ! -f $id_token_file -o ! -s $id_token_file ]; then
    # generate the token file
    echo "BSDstats runs on this system for the first time, generating registration ID"
    IDTOKEN=$(uri_escape $(${OPENSSL} rand -base64 32))
    if [ $? -ne 0 ]; then
      fail "Failed to generate IDTOKEN"
    fi

    # receive KEY/TOKEN
    local body
    body=$(do_http_request "GET" "/scripts/getid.php?key=${IDTOKEN}" "" "" 1)
    if [ $? -ne 0 ]; then
      fail "HTTP query failed during key/token generation"
    fi
    KEY=$(extract_field "${body}" "KEY")
    TOKEN=$(extract_field "${body}" "TOKEN")
    # validate KEY/TOKEN
    if [ ${#KEY} -lt 10 -o ${#KEY} -gt 64 -o ${#TOKEN} -lt 10 -o ${#TOKEN} -gt 64 ]; then
      log "FAIL" "Invalid key/token received for IDTOKEN=${TOKEN}"
      fail "Invalid key/token combination received from the server"
    fi
    log "INFO" "Generated idtoken='${IDTOKEN}', received key=${KEY} and token=${TOKEN}"
    # save KEY/TOKEN
    (echo "# This file was auto-generated on $(date),"; \
     echo "# and contains the BSDstats registration credentials"; \
     echo "KEY=${KEY}"; echo "TOKEN=${TOKEN}"; echo "VERSION=${CURR_VERSION}") > $id_token_file && \
      ${CHOWN} root:wheel $id_token_file && \
      ${CHMOD} 600 $id_token_file
    if [ $? -ne 0 ]; then
      ${RM} -f $id_token_file
      fail "Failed to create identification file $id_token_file"
    fi
    log "INFO" "Created identification file $id_token_file"
  fi
  # read the token file into the global variables
  . $id_token_file
  KEY=$(uri_escape $KEY)
  TOKEN=$(uri_escape $TOKEN)
  PREV_VERSION="${VERSION}"
  VERSION=""
}

enable_token() {
  # XXX key and token are swapped here, this has been like that from version 5.5, not sure if fixing will break it
  do_http_request_check_status "GET" "/scripts/enable_token.php?key=${TOKEN}&token=${KEY}" \
    "" "" "token enabling"
  log "INFO" "System enabled"
}

disable_token() {
  do_http_request_check_status "GET" "/scripts/disable_token.php?key=${TOKEN}&token=${KEY}" \
    "" "" "token disabling"
  log "INFO" "System disabled"
}

report_system() {
  local REL=$(${UNAME} -r)
  local ARCH=$(${UNAME} -m)
  local OS=$(${UNAME} -s)
  echo_begin "Posting OS statistics to ${checkin_server_description}"
  do_http_request_check_status "GET" "/scripts/report_system.php?token=${TOKEN}&key=${KEY}&rel=${REL}&arch=${ARCH}&opsys=${OS}" \
    "" "" "OS statistics sumbission"
  echo_end_success
  log "INFO" "Posted OS statistics to ${checkin_server_description}"
}

report_cpu() {
  local line=$(${SYSCTL} -n hw.model)
  local VEN=$(echo $line | ${CUT} -d ' ' -f 1)
  local DEV=$(uri_escape $(echo $line | ${CUT} -d ' ' -f 2-))
  local count=$(${SYSCTL} -n hw.ncpu)
  echo_begin "Posting CPU information to ${checkin_server_description}"
  do_http_request_check_status "GET" "/scripts/report_cpu.php?token=${TOKEN}&key=${KEY}&cpus=${count}&vendor=${VEN}&cpu_type=${DEV}" \
      "" "" "CPU information sumbission"
  echo_end_success
  log "INFO" "Posted CPU information to ${checkin_server_description}"
}

report_all() {
  # network setup
  setup_proxies
  test_connection
  log "INIT" "Connected to ${checkin_server_description}"
  # sleep random number of seconds by default
  test X"$1" = X-nodelay || ${SLEEP} $(random)
  # prepare
  get_id_token
  # begin
  enable_token
  report_system
  # optional parts
  case "$monthly_statistics_report_devices" in
    [Yy][Ee][Ss])
       report_devices
       report_cpu
       ;;
    [Nn][Oo])
       echo "Posting monthly device/CPU statistics disabled"
       echo "    set monthly_statistics_report_devices=\"YES\" in $periodic_conf"
       ;;
    *)
       # opt-out for devices
       report_devices
       report_cpu
       ;;
  esac
  case "$monthly_statistics_report_ports" in
    [Yy][Ee][Ss])
      report_ports
      ;;
    [Nn][Oo])
      echo "Posting monthly ports statistics disabled"
      echo "    set monthly_statistics_report_ports=\"YES\" in $periodic_conf"
      ;;
    *)
      # opt-out for ports
      report_ports
      ;;
  esac
  # end
  disable_token
}

##
## MAIN: processing begins here
##

rc=0

case "$monthly_statistics_enable" in
  [Yy][Ee][Ss])
    # explicitly enabled: report it
    report_all "$1"
    ;;
  [Nn][Oo])
    echo "Posting monthly OS statistics disabled"
    echo "    set monthly_statistics_enable=\"YES\" in $periodic_conf"
    rc=1
    ;;
  *)
    # opt-out: we report when user have BSDstats installed, and user didn't say "NO"
    report_all "$1"
    ;;
esac

# success
log "SUCC" "Finished successfully"
${UMASK} $oldmask
exit ${rc}

Line 0 Link Here

(-)sysutils/bsdstats/files/bsdstats-update.in (+8 lines)
	1	#!/bin/sh
	2
	3	if [ "$(id -u)" != "0" ]; then
	4	echo "Only root can run BSDstats update"
	5	exit 1
	6	fi
	7
	8	%%PREFIX%%/etc/periodic/monthly/300.statistics -nodelay

Lines 1-15 Link Here

(-)sysutils/bsdstats/files/pkg-message.in (-8 / +14 lines)
1	********************	1	======================================================================
2	To enable monthly reporting, add these lines to /etc/periodic.conf:	2	You installed BSDstats: script reporting statistics about your machine
3	monthly_statistics_enable="YES"	3
4	monthly_statistics_report_devices="YES"	4	To disable monthly reporting, add this line to /etc/periodic.conf:
5	monthly_statistics_report_ports="YES"	5	monthly_statistics_enable="NO"
		6
		7	To disable parts of reporting, add these lines to /etc/periodic.conf:
		8	monthly_statistics_report_devices="NO"
		9	monthly_statistics_report_ports="NO"
6		10
7	To enable reporting on bootup, add this line to /etc/rc.conf:	11	To enable reporting on bootup, add this line to /etc/rc.conf:
8	bsdstats_enable="YES"	12	bsdstats_enable="YES"
9		13
10	To run it manually the first time:	14	To run it manually any time:
11	%%PREFIX%%/etc/periodic/monthly/300.statistics -nodelay	15	bsdstats-update
12		16
13	To view current statistics, go to:	17	To view current statistics, go to:
14	http://www.bsdstats.org/	18	http://www.bsdstats.org/
15	********************	19
		20	@@TOR_MESSAGE@@
		21	======================================================================




# pkg-install : based off ${PORTSDIR}/mail/courier/files/pkg-install.in

# The default answer to each of the installation questions is "yes".  You can
# override a question's default by setting its environment variable to "no".
# 
# Environment Variable      | Question
# --------------------------+------------------------------------------------------------------
# BSDSTATS_MONTHLY_ENABLE   | Would you like to enable monthly reporting in /etc/periodic.conf?
# BSDSTATS_MONTHLY_DEVICES  | Would you like to send a list of installed hardware as well?
# BSDSTATS_MONTHLY_PORTS    | Would you like to send a list of installed ports as well?
# BSDSTATS_MONTHLY_NOW      | Would you like to run it now?
# BSDSTATS_REBOOT_REPORTING | Would you like to enable reporting on bootup in /etc/rc.conf?

if [ -n "$PACKAGE_BUILDING" ]; then
	BSDSTATS_MONTHLY_ENABLE=${BSDSTATS_MONTHLY_ENABLE:=no}
	BSDSTATS_MONTHLY_DEVICES=${BSDSTATS_MONTHLY_DEVICES:=no}
	BSDSTATS_MONTHLY_PORTS=${BSDSTATS_MONTHLY_PORTS:=no}
	BSDSTATS_MONTHLY_NOW=${BSDSTATS_MONTHLY_NOW:=no}
	BSDSTATS_REBOOT_REPORTING=${BSDSTATS_REBOOT_REPORTING:=no}
else
	BSDSTATS_MONTHLY_ENABLE=${BSDSTATS_MONTHLY_ENABLE:=yes}
	BSDSTATS_MONTHLY_DEVICES=${BSDSTATS_MONTHLY_DEVICES:=yes}
	BSDSTATS_MONTHLY_PORTS=${BSDSTATS_MONTHLY_PORTS:=yes}
	BSDSTATS_MONTHLY_NOW=${BSDSTATS_MONTHLY_NOW:=yes}
	BSDSTATS_REBOOT_REPORTING=${BSDSTATS_REBOOT_REPORTING:=yes}
fi

}

if [ "$2" = "POST-INSTALL" ]; then
	if yesno "Would you like to run BSDstats now" $BSDSTATS_MONTHLY_NOW; then
		${INSTALL_PREFIX}${PKG_PREFIX}/etc/periodic/monthly/300.statistics -nodelay
			echo "monthly_statistics_enable=\"YES\"" >> /etc/periodic.conf
			if yesno "Would you like to send a list of installed hardware as well" $BSDSTATS_MONTHLY_DEVICES; then
				echo "monthly_statistics_report_devices=\"YES\"" >> /etc/periodic.conf
			fi
			if yesno "Would you like to send a list of installed ports as well" $BSDSTATS_MONTHLY_PORTS; then
				echo "monthly_statistics_report_ports=\"YES\"" >> /etc/periodic.conf
			fi
			if yesno "Would you like to run it now" $BSDSTATS_MONTHLY_NOW; then
				${PKG_PREFIX}/etc/periodic/monthly/300.statistics -nodelay
			fi
		fi
	fi
	if [ ! -f "/etc/rc.conf" ] || [ -z "`grep bsdstats_enable /etc/rc.conf`" ]; then
		echo

Line 1 Link Here

(-)sysutils/bsdstats/pkg-plist (+1 lines)
1	etc/periodic/monthly/300.statistics	1	etc/periodic/monthly/300.statistics
		2	bin/bsdstats-update

Return to bug 198799

Lines 2-36 Link Here

(-)sysutils/bsdstats/Makefile (-13 / +24 lines)
2	# $FreeBSD: head/sysutils/bsdstats/Makefile 339133 2014-01-08 13:53:59Z lme $	2	# $FreeBSD: head/sysutils/bsdstats/Makefile 339133 2014-01-08 13:53:59Z lme $
3		3
4	PORTNAME= bsdstats	4	PORTNAME= bsdstats
5	PORTVERSION= 5.5	5	PORTVERSION= 6.0
6	PORTREVISION= 5
7	CATEGORIES= sysutils	6	CATEGORIES= sysutils
8	DISTFILES=	7	DISTFILES=
9		8
10	MAINTAINER= bsdstats@nanoman.ca	9	MAINTAINER= yuri@rawbw.com
11	COMMENT= Monthly script for reporting anonymous statistics about your machine	10	COMMENT= Monthly script for reporting anonymous statistics about your machine
12		11
		12	LICENSE= BSD4CLAUSE
		13
13	NO_BUILD= yes	14	NO_BUILD= yes
14	USE_RC_SUBR= bsdstats	15	USE_RC_SUBR= bsdstats
15	SUB_FILES= 300.statistics pkg-message	16	SUB_FILES= 300.statistics bsdstats-update pkg-message
16	SUB_LIST+= DIG=${DIG}	17	SUB_LIST+= VERSION=${PORTVERSION}
		18	NO_ARCH= YES
		19
		20	OPTIONS_DEFINE= TOR
		21	TOR_DESC= Submit securely through Tor anonymity network
17		22
18	.include <bsd.port.pre.mk>	23	.include <bsd.port.pre.mk>
19		24
20	.if ${OSVERSION} >= 1000500	25	.if ${PORT_OPTIONS:MTOR}
21	DIG= drill	26	RUN_DEPENDS+= tor:${PORTSDIR}/security/tor
		27	.endif
		28
		29	pre-install:
		30	.if ${PORT_OPTIONS:MTOR}
		31	@${REINPLACE_CMD} -e 's\|USE_TOR=NO\|USE_TOR=YES\|' ${WRKDIR}/300.statistics
		32	@${REINPLACE_CMD} -e 's\|# REQUIRE: LOGIN\|# REQUIRE: LOGIN tor\|' ${WRKDIR}/bsdstats
		33	@${REINPLACE_CMD} -e 's\|@@TOR_MESSAGE@@\|Statistics will be submitted anonymously through the TOR network\|' \
		34	${WRKDIR}/pkg-message
22	.else	35	.else
23	DIG= dig	36	@${REINPLACE_CMD} -e 's\|@@TOR_MESSAGE@@\|You can build bsdstats with TOR port option to submit anonymously\|' \
		37	${WRKDIR}/pkg-message
24	.endif	38	.endif
25		39
26	do-install:	40	do-install:
27	${MKDIR} ${STAGEDIR}${PREFIX}/etc/periodic/monthly	41	${MKDIR} ${STAGEDIR}${PREFIX}/etc/periodic/monthly
28	${INSTALL_SCRIPT} ${WRKDIR}/300.statistics \	42	${INSTALL_SCRIPT} ${WRKDIR}/300.statistics \
29	${STAGEDIR}${PREFIX}/etc/periodic/monthly	43	${STAGEDIR}${PREFIX}/etc/periodic/monthly
30		44	${INSTALL_SCRIPT} ${WRKDIR}/bsdstats-update \
31	post-install:	45	${STAGEDIR}${PREFIX}/bin/bsdstats-update
32	.if ! defined(BATCH) && ! defined(PACKAGE_BUILDING)
33	@PKG_PREFIX="${PREFIX}" ${SH} ${PKGINSTALL} ${PKGNAME} POST-INSTALL
34	.endif
35		46
36	.include <bsd.port.post.mk>	47	.include <bsd.port.post.mk>

Lines 2-27 Link Here

(-)sysutils/bsdstats/pkg-install (-23 / +3 lines)
2	# pkg-install : based off ${PORTSDIR}/mail/courier/files/pkg-install.in	2	# pkg-install : based off ${PORTSDIR}/mail/courier/files/pkg-install.in
3		3
4	# The default answer to each of the installation questions is "yes". You can	4	# The default answer to each of the installation questions is "yes". You can
5	# override a questions's default by setting its environment variable to "no".	5	# override a question's default by setting its environment variable to "no".
6	#	6	#
7	# Environment Variable \| Question	7	# Environment Variable \| Question
8	# --------------------------+------------------------------------------------------------------	8	# --------------------------+------------------------------------------------------------------
9	# BSDSTATS_MONTHLY_ENABLE \| Would you like to enable monthly reporting in /etc/periodic.conf?
10	# BSDSTATS_MONTHLY_DEVICES \| Would you like to send a list of installed hardware as well?
11	# BSDSTATS_MONTHLY_PORTS \| Would you like to send a list of installed ports as well?
12	# BSDSTATS_MONTHLY_NOW \| Would you like to run it now?	9	# BSDSTATS_MONTHLY_NOW \| Would you like to run it now?
13	# BSDSTATS_REBOOT_REPORTING \| Would you like to enable reporting on bootup in /etc/rc.conf?	10	# BSDSTATS_REBOOT_REPORTING \| Would you like to enable reporting on bootup in /etc/rc.conf?
14		11
15	if [ -n "$PACKAGE_BUILDING" ]; then	12	if [ -n "$PACKAGE_BUILDING" ]; then
16	BSDSTATS_MONTHLY_ENABLE=${BSDSTATS_MONTHLY_ENABLE:=no}
17	BSDSTATS_MONTHLY_DEVICES=${BSDSTATS_MONTHLY_DEVICES:=no}
18	BSDSTATS_MONTHLY_PORTS=${BSDSTATS_MONTHLY_PORTS:=no}
19	BSDSTATS_MONTHLY_NOW=${BSDSTATS_MONTHLY_NOW:=no}	13	BSDSTATS_MONTHLY_NOW=${BSDSTATS_MONTHLY_NOW:=no}
20	BSDSTATS_REBOOT_REPORTING=${BSDSTATS_REBOOT_REPORTING:=no}	14	BSDSTATS_REBOOT_REPORTING=${BSDSTATS_REBOOT_REPORTING:=no}
21	else	15	else
22	BSDSTATS_MONTHLY_ENABLE=${BSDSTATS_MONTHLY_ENABLE:=yes}
23	BSDSTATS_MONTHLY_DEVICES=${BSDSTATS_MONTHLY_DEVICES:=yes}
24	BSDSTATS_MONTHLY_PORTS=${BSDSTATS_MONTHLY_PORTS:=yes}
25	BSDSTATS_MONTHLY_NOW=${BSDSTATS_MONTHLY_NOW:=yes}	16	BSDSTATS_MONTHLY_NOW=${BSDSTATS_MONTHLY_NOW:=yes}
26	BSDSTATS_REBOOT_REPORTING=${BSDSTATS_REBOOT_REPORTING:=yes}	17	BSDSTATS_REBOOT_REPORTING=${BSDSTATS_REBOOT_REPORTING:=yes}
27	fi	18	fi
Lines 56-74 Link Here
56	}	47	}
57		48
58	if [ "$2" = "POST-INSTALL" ]; then	49	if [ "$2" = "POST-INSTALL" ]; then
59	if [ ! -f "/etc/periodic.conf" ] \|\| [ -z "`grep monthly_statistics /etc/periodic.conf`" ]; then	50	if yesno "Would you like to run BSDstats now" $BSDSTATS_MONTHLY_NOW; then
60	if yesno "Would you like to enable monthly reporting in /etc/periodic.conf" $BSDSTATS_MONTHLY_ENABLE; then	51	${INSTALL_PREFIX}${PKG_PREFIX}/etc/periodic/monthly/300.statistics -nodelay
61	echo "monthly_statistics_enable=\"YES\"" >> /etc/periodic.conf
62	if yesno "Would you like to send a list of installed hardware as well" $BSDSTATS_MONTHLY_DEVICES; then
63	echo "monthly_statistics_report_devices=\"YES\"" >> /etc/periodic.conf
64	fi
65	if yesno "Would you like to send a list of installed ports as well" $BSDSTATS_MONTHLY_PORTS; then
66	echo "monthly_statistics_report_ports=\"YES\"" >> /etc/periodic.conf
67	fi
68	if yesno "Would you like to run it now" $BSDSTATS_MONTHLY_NOW; then
69	${PKG_PREFIX}/etc/periodic/monthly/300.statistics -nodelay
70	fi
71	fi
72	fi	52	fi
73	if [ ! -f "/etc/rc.conf" ] \|\| [ -z "`grep bsdstats_enable /etc/rc.conf`" ]; then	53	if [ ! -f "/etc/rc.conf" ] \|\| [ -z "`grep bsdstats_enable /etc/rc.conf`" ]; then
74	echo	54	echo