#!/usr/bin/bash

# ncid-kpopup
# usage: ncid --no-gui --module ncid-kpopup

# Created by Randy L. Rasmussen on Thu Dec 20, 2007

# Last edited: Dec 8, 2020

# Copyright (c) 2007-2018 by
#   Randy L. Rasmussen
#   John L. Chmielewski <jlc@users.sourceforge.net>

# Display a popup caption and speak the caller id
# Requires kdialog (for popup) and festival (to speak)

ConfigDir=/etc/ncid/conf.d
ConfigFile=$ConfigDir/ncid-kpopup.conf

# WARNING: module ncid-kpopup may call ncid-speak
#          be sure ncid-kpopup passes stdin correctly to ncid-speak

ncid_speak=/usr/share/ncid/ncid-speak

### defaults if not using config file ###
###  see $ConfigFile for description  ###
allowed_types="ALLTYPES"
kdialog=/usr/bin/kdialog
kpopup_geo="0x0+1600+1000" #Display in the bottom right corner of a 22" monitor
kpopup_timeout=10 #Displays popup for X number of seconds used by kdialog
kpopup_speak=""

[ -f $ConfigFile ] && . $ConfigFile

# backward compatibility for pre-NCID 1.8 config files
  [ -n "$kpopup_types" ] && allowed_types="$kpopup_types"

# === Start of common module script routines - ncid-modules-common.sh

# Last edited: Jun 30, 2022

# Before this code is executed:
#    - set $allowed_types as desired
#
# After this code is executed:
#    - stdin will have been read into $DATE, $TIME, $NMBR, $NAME, etc.
#    - $found=1 if $TYPE is in $allowed_types; otherwise $found will be null
#    - $type_cat(egory) will be "CALLTYPE", "MSGTYPE", or "UNKNOWNTYPE"
#    - $type_smart_phone is "Y" for both smart phone calls and messages,
#      otherwise $type_smart_phone will be null
#    - $type_desc(ription) will be set to human readable verbiage

# $allowed_types can be:
#    - any mix of zero or more individual call/line types separated by spaces
#    - any mix of zero or more type categories separated by spaces
#    - the special category "ALLTYPES"
#    - null, which defaults to "ALLTYPES"
#
# If $allowed_types includes spaces, you must surround the list with quotes.
#
# Note that "ALLTYPES" causes **any** $TYPE to be accepted.
#
# Examples:
#    allowed_types="CALLTYPE"
#    allowed_types="CALLTYPE MSGTYPE"
#    allowed_types="CID MSGTYPE HUP"

# input is always 12 lines
INPUT="DATE TIME NMBR NAME LINE TYPE MESG MTYPE FNMBR CTRY LOCA CARI"
for i in $INPUT; do read $i; done

# if input is from a call:
# input: DATE\nTIME\nNMBR\nNAME\nLINE\nTYPE\n""\n""\nFNMBR\nCTRY\nLOCA\nCARI\n
#
# if input is from a message
# input: DATE\nTIME\nNMBR\nNAME\nLINE\nTYPE\nMESG\nMTYPE\nFNMBR\nCTRY\nLOCA\nCARI\n

# determine $TYPE category and description
  type_cat="UNKNOWNTYPE"
  type_desc="Unknown Call Type ($TYPE)"
  type_smart_phone=

case "$TYPE" in

  BLK) type_cat=CALLTYPE;  type_smart_phone= ; type_desc="Blacklisted Call Blocked";;
  CID) type_cat=CALLTYPE;  type_smart_phone= ; type_desc="Incoming Call";;
  HUP) type_cat=CALLTYPE;  type_smart_phone= ; type_desc="Blacklisted Call Hangup";;
  MWI) type_cat=CALLTYPE;  type_smart_phone= ; type_desc="Voicemail Message Waiting";;
  OUT) type_cat=CALLTYPE;  type_smart_phone= ; type_desc="Outgoing Call";;
  PID) type_cat=CALLTYPE;  type_smart_phone=Y; type_desc="Caller ID from a smart phone";;
  PUT) type_cat=CALLTYPE;  type_smart_phone=Y; type_desc="Outgoing Smart Phone Call";;
  RID) type_cat=CALLTYPE;  type_smart_phone= ; type_desc="Ringback Call";;
  WID) type_cat=CALLTYPE;  type_smart_phone= ; type_desc="Call Waiting Caller ID";;

  MSG)  type_cat=MSGTYPE;  type_smart_phone= ; type_desc="Message";;
  NOT)  type_cat=MSGTYPE;  type_smart_phone=Y; type_desc="Notice of a smart phone message";;

esac

# Is this $TYPE one that can be processed by this module?
found=
if [ -z "$allowed_types" ]
then
    allowed_types="ALLTYPES"
    found=1
else
    for i in $allowed_types
    do
        if   [ $i = "ALLTYPES" ];  then found=1; break;
        elif [ $i = "$type_cat" ]; then found=1; break;
        elif [ $i = "$TYPE" ];     then found=1; break;
        fi
    done
fi

# === End of common module script routines - ncid-modules-common.sh

# Exit if $TYPE not found
[ -z "$found" ] && exit 0

# set notification title
  title="${type_desc}:"

if [ "$type_cat" = "MSGTYPE" ]
then
    $kdialog --geometry $kpopup_geo --title "$title" --passivepopup \
         "$MESG" $kpopup_timeout &
else
    $kdialog --geometry $kpopup_geo --title "$title" --passivepopup \
         "$TYPE $NAME $FNMBR" $kpopup_timeout &

    # this speaks if there is a match
    if [ "$kpopup_speak" = "enable" ]
    then
        # Added the following to unmute Line in for kmix if muted
        muted=$(dcop kmix Mixer0 mute 2)
        if [ "$muted" = "true" ] #If volume is muted
        then
        dcop kmix Mixer0 toggleMute 2
        fi

        # call the ncid-speak module
        echo -e "$TYPE\n$DATE\n$TIME\n$LINE\n$FNMBR\n$NAME\n$MTYPE\n$MESG\n" | $ncid_speak
    fi
fi

exit 0
