keys.go

// Copyright © 2018 Mikael Berthe <mikael@lilotux.net>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package samtv

import (
	"encoding/json"
	"strconv"

	"github.com/pkg/errors"
	"github.com/sirupsen/logrus"
)

// SamsungKeyList is a list of known Samsung key identifiers
var SamsungKeyList = []string{
	"KEY_0",
	"KEY_1",
	"KEY_11",
	"KEY_12",
	"KEY_16_9",
	"KEY_2",
	"KEY_3",
	"KEY_3SPEED",
	"KEY_4",
	"KEY_4_3",
	"KEY_5",
	"KEY_6",
	"KEY_7",
	"KEY_8",
	"KEY_9",
	"KEY_AD",
	"KEY_ADDDEL",
	"KEY_ALT_MHP",
	"KEY_ANGLE",
	"KEY_ANTENA",
	"KEY_ANYNET",
	"KEY_ANYVIEW",
	"KEY_APP_LIST",
	"KEY_ASPECT",
	"KEY_AUTO_ARC_ANTENNA_AIR",
	"KEY_AUTO_ARC_ANTENNA_CABLE",
	"KEY_AUTO_ARC_ANTENNA_SATELLITE",
	"KEY_AUTO_ARC_ANYNET_AUTO_START",
	"KEY_AUTO_ARC_ANYNET_MODE_OK",
	"KEY_AUTO_ARC_AUTOCOLOR_FAIL",
	"KEY_AUTO_ARC_AUTOCOLOR_SUCCESS",
	"KEY_AUTO_ARC_C_FORCE_AGING",
	"KEY_AUTO_ARC_CAPTION_ENG",
	"KEY_AUTO_ARC_CAPTION_KOR",
	"KEY_AUTO_ARC_CAPTION_OFF",
	"KEY_AUTO_ARC_CAPTION_ON",
	"KEY_AUTO_ARC_JACK_IDENT",
	"KEY_AUTO_ARC_LNA_OFF",
	"KEY_AUTO_ARC_LNA_ON",
	"KEY_AUTO_ARC_PIP_CH_CHANGE",
	"KEY_AUTO_ARC_PIP_DOUBLE",
	"KEY_AUTO_ARC_PIP_LARGE",
	"KEY_AUTO_ARC_PIP_LEFT_BOTTOM",
	"KEY_AUTO_ARC_PIP_LEFT_TOP",
	"KEY_AUTO_ARC_PIP_RIGHT_BOTTOM",
	"KEY_AUTO_ARC_PIP_RIGHT_TOP",
	"KEY_AUTO_ARC_PIP_SMALL",
	"KEY_AUTO_ARC_PIP_SOURCE_CHANGE",
	"KEY_AUTO_ARC_PIP_WIDE",
	"KEY_AUTO_ARC_RESET",
	"KEY_AUTO_ARC_USBJACK_INSPECT",
	"KEY_AUTO_FORMAT",
	"KEY_AUTO_PROGRAM",
	"KEY_AV1",
	"KEY_AV2",
	"KEY_AV3",
	"KEY_BACK_MHP",
	"KEY_BOOKMARK",
	"KEY_CALLER_ID",
	"KEY_CAPTION",
	"KEY_CATV_MODE",
	"KEY_CH_LIST",
	"KEY_CHDOWN",
	"KEY_CHUP",
	"KEY_CLEAR",
	"KEY_CLOCK_DISPLAY",
	"KEY_COMPONENT1",
	"KEY_COMPONENT2",
	"KEY_CONTENTS",
	"KEY_CONVERGENCE",
	"KEY_CONVERT_AUDIO_MAINSUB",
	"KEY_CUSTOM",
	"KEY_CYAN",
	"KEY_DEVICE_CONNECT",
	"KEY_DISC_MENU",
	"KEY_DMA",
	"KEY_DNET",
	"KEY_DNIe",
	"KEY_DNSe",
	"KEY_DOOR",
	"KEY_DOWN",
	"KEY_DSS_MODE",
	"KEY_DTV",
	"KEY_DTV_LINK",
	"KEY_DTV_SIGNAL",
	"KEY_DVD_MODE",
	"KEY_DVI",
	"KEY_DVR",
	"KEY_DVR_MENU",
	"KEY_DYNAMIC",
	"KEY_ENTER",
	"KEY_ENTERTAINMENT",
	"KEY_ESAVING",
	"KEY_EXIT",
	"KEY_EXT1",
	"KEY_EXT10",
	"KEY_EXT11",
	"KEY_EXT12",
	"KEY_EXT13",
	"KEY_EXT14",
	"KEY_EXT15",
	"KEY_EXT16",
	"KEY_EXT17",
	"KEY_EXT18",
	"KEY_EXT19",
	"KEY_EXT2",
	"KEY_EXT20",
	"KEY_EXT21",
	"KEY_EXT22",
	"KEY_EXT23",
	"KEY_EXT24",
	"KEY_EXT25",
	"KEY_EXT26",
	"KEY_EXT27",
	"KEY_EXT28",
	"KEY_EXT29",
	"KEY_EXT3",
	"KEY_EXT30",
	"KEY_EXT31",
	"KEY_EXT32",
	"KEY_EXT33",
	"KEY_EXT34",
	"KEY_EXT35",
	"KEY_EXT36",
	"KEY_EXT37",
	"KEY_EXT38",
	"KEY_EXT39",
	"KEY_EXT4",
	"KEY_EXT40",
	"KEY_EXT41",
	"KEY_EXT5",
	"KEY_EXT6",
	"KEY_EXT7",
	"KEY_EXT8",
	"KEY_EXT9",
	"KEY_FACTORY",
	"KEY_FAVCH",
	"KEY_FF",
	"KEY_FF_",
	"KEY_FM_RADIO",
	"KEY_GAME",
	"KEY_GREEN",
	"KEY_GUIDE",
	"KEY_HDMI",
	"KEY_HDMI1",
	"KEY_HDMI2",
	"KEY_HDMI3",
	"KEY_HDMI4",
	"KEY_HELP",
	"KEY_HOME",
	"KEY_ID_INPUT",
	"KEY_ID_SETUP",
	"KEY_INFO",
	"KEY_INSTANT_REPLAY",
	"KEY_LEFT",
	"KEY_LINK",
	"KEY_LIVE",
	"KEY_MAGIC_BRIGHT",
	"KEY_MAGIC_CHANNEL",
	"KEY_MDC",
	"KEY_MENU",
	"KEY_MIC",
	"KEY_MORE",
	"KEY_MOVIE1",
	"KEY_MS",
	"KEY_MTS",
	"KEY_MUTE",
	"KEY_NINE_SEPERATE",
	"KEY_OPEN",
	"KEY_PANNEL_CHDOWN",
	"KEY_PANNEL_CHUP",
	"KEY_PANNEL_ENTER",
	"KEY_PANNEL_MENU",
	"KEY_PANNEL_POWER",
	"KEY_PANNEL_SOURCE",
	"KEY_PANNEL_VOLDOW",
	"KEY_PANNEL_VOLUP",
	"KEY_PANORAMA",
	"KEY_PAUSE",
	"KEY_PCMODE",
	"KEY_PERPECT_FOCUS",
	"KEY_PICTURE_SIZE",
	"KEY_PIP_CHDOWN",
	"KEY_PIP_CHUP",
	"KEY_PIP_ONOFF",
	"KEY_PIP_SCAN",
	"KEY_PIP_SIZE",
	"KEY_PIP_SWAP",
	"KEY_PLAY",
	"KEY_PLUS100",
	"KEY_PMODE",
	"KEY_POWER",
	"KEY_POWEROFF",
	"KEY_POWERON",
	"KEY_PRECH",
	"KEY_PRINT",
	"KEY_PROGRAM",
	"KEY_QUICK_REPLAY",
	"KEY_REC",
	"KEY_RED",
	"KEY_REPEAT",
	"KEY_RESERVED1",
	"KEY_RETURN",
	"KEY_REWIND",
	"KEY_REWIND_",
	"KEY_RIGHT",
	"KEY_RSS",
	"KEY_RSURF",
	"KEY_SCALE",
	"KEY_SEFFECT",
	"KEY_SETUP_CLOCK_TIMER",
	"KEY_SLEEP",
	"KEY_SOUND_MODE",
	"KEY_SOURCE",
	"KEY_SRS",
	"KEY_STANDARD",
	"KEY_STB_MODE",
	"KEY_STILL_PICTURE",
	"KEY_STOP",
	"KEY_SUB_TITLE",
	"KEY_SVIDEO1",
	"KEY_SVIDEO2",
	"KEY_SVIDEO3",
	"KEY_TOOLS",
	"KEY_TOPMENU",
	"KEY_TTX_MIX",
	"KEY_TTX_SUBFACE",
	"KEY_TURBO",
	"KEY_TV",
	"KEY_TV_MODE",
	"KEY_UP",
	"KEY_VCHIP",
	"KEY_VCR_MODE",
	"KEY_VOLDOWN",
	"KEY_VOLUP",
	"KEY_W_LINK",
	"KEY_WHEEL_LEFT",
	"KEY_WHEEL_RIGHT",
	"KEY_YELLOW",
	"KEY_ZOOM_IN",
	"KEY_ZOOM_MOVE",
	"KEY_ZOOM_OUT",
	"KEY_ZOOM1",
	"KEY_ZOOM2",
}

// GetKeyCodeList returns a list of key codes
func GetKeyCodeList() (list []string) {
	list = append(list, SamsungKeyList...)
	return
}

// Key sends a key to the TV device
func (s *SmartViewSession) Key(key string) error {
	if s == nil {
		return errors.New("Key called but no established connection")
	}
	if key == "" {
		logrus.Info("Empty key -- ignored")
		return nil
	}

	// TODO:  check the key id is in the list

	s.ws.mux.Lock()
	if s.ws.state == stateNotConnected {
		s.ws.mux.Unlock()
		logrus.Debug("Key: need to open new websocket")
		if err := s.InitSession(); err != nil {
			return errors.Wrap(err, "failed to open websocket connection")
		}
	} else {
		s.ws.mux.Unlock()
	}

	return s.sendKey(key)
}

// sendKey sends a SmartView-formatted message for a key press
func (s *SmartViewSession) sendKey(text string) error {
	if s.ws.state != stateConnected {
		return errors.New("sendKey: no active connection")
	}

	logrus.Debugf("sendMessage('%s')", text)

	// Encrypt payload
	data, err := s.aesEncrypt([]byte(s.smartViewJSONBodyKeyPress(text)))
	if err != nil {
		return errors.Wrap(err, "cannot encrypt message")
	}

	// Convert payload to integer array
	var body string
	for i, n := range data {
		if i > 0 {
			body += ", "
		}
		body += strconv.Itoa(int(n))
	}

	// Build and send message
	m := s.buildMessage(body)

	if err := s.sendWSMessage(m); err != nil {
		return err
	}

	m = s.GetMessage(true)
	if m == "" {
		return errors.New("no reply from TV")
	}

	logrus.Debugf("TV message: `%s`", m)

	result, err := parseSmartMessageResult("{" + m)
	if err != nil {
		return errors.Wrap(err, "incorrect TV reply")
	}
	if result != "" {
		logrus.Debugf("TV result: `%s`", result)
	}

	return nil
}

func (s *SmartViewSession) smartViewJSONBodyKeyPress(keyPressed string) string {
	// TODO build JSON string properly
	return `{"method":"POST","body":{"plugin":"RemoteControl","param1":"uuid:` +
		s.uuid + `","param2":"Click","param3":"` + keyPressed +
		`","param4":false,"api":"SendRemoteKey","version":"1.000"}}`
}

func parseSmartMessageResult(msg string) (string, error) {
	res := struct {
		Result json.RawMessage `json:"result"`
	}{}
	if err := json.Unmarshal([]byte(msg), &res); err != nil {
		return "", errors.New("cannot parse message")
	}

	rs := string(res.Result)

	// Empty result?
	if rs == "{}" {
		return "", nil
	}

	// Try to decode result as string
	var s string
	if err := json.Unmarshal(res.Result, &s); err == nil {
		return s, nil
	}

	// Could not unmarshal; send the raw JSON result
	return rs, nil
}