ChanSort/source/ChanSort.Loader.LG/GlobalClone/GcJsonSerializer.cs

using System;
using System.Globalization;
using System.IO;
using System.Text;
using ChanSort.Api;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

namespace ChanSort.Loader.GlobalClone
{
  /*
   * LG's webOS 5 firmware has severe limitations (or bugs) regarding the import of channel lists (at the time of this writing, end of 2020).
   * There have been a few reports about successful imports, but no conclusions about steps that guarantee success.
   * More information can be found on https://github.com/PredatH0r/ChanSort/discussions/207
   */
  internal class GcJsonSerializer : SerializerBase
  {
    private readonly string content;
    private string xmlPrefix;
    private string xmlSuffix;
    private JObject doc;
    private readonly IniFile.Section ini;

    public GcJsonSerializer(string filename, string content) : base(filename)
    {
      this.content = content;

      this.Features.DeleteMode = DeleteMode.NotSupported; //.FlagWithoutPrNr; 
      this.Features.ChannelNameEdit = ChannelNameEditMode.All;
      this.Features.FavoritesMode = FavoritesMode.None;
      this.Features.CanHaveGaps = true;
      this.Features.CanHideChannels = true;
      this.Features.CanSkipChannels = true;
      this.Features.CanLockChannels = true;
      this.Features.CanEditAudioPid = false;

      this.DataRoot.AddChannelList(new ChannelList(SignalSource.AnalogT  | SignalSource.Tv | SignalSource.Data, "Analog Antenna"));
      this.DataRoot.AddChannelList(new ChannelList(SignalSource.DvbT | SignalSource.Tv | SignalSource.Data, "DVB-T TV"));
      this.DataRoot.AddChannelList(new ChannelList(SignalSource.DvbT | SignalSource.Radio, "DVB-T Radio"));
      this.DataRoot.AddChannelList(new ChannelList(SignalSource.AnalogC | SignalSource.Tv | SignalSource.Data, "Analog Cable"));
      this.DataRoot.AddChannelList(new ChannelList(SignalSource.DvbC | SignalSource.Tv | SignalSource.Data, "DVB-C TV"));
      this.DataRoot.AddChannelList(new ChannelList(SignalSource.DvbC | SignalSource.Radio, "DVB-C Radio"));
      this.DataRoot.AddChannelList(new ChannelList(SignalSource.DvbS | SignalSource.Tv | SignalSource.Data, "DVB-S TV"));
      this.DataRoot.AddChannelList(new ChannelList(SignalSource.DvbS | SignalSource.Radio, "DVB-S Radio"));

      string iniFile = this.GetType().Assembly.Location.ToLowerInvariant().Replace(".dll", ".ini");
      this.ini = new IniFile(iniFile).GetSection("webOS 5", false);
    }

    #region Load()
    public override void Load()
    {
      var startTag = "<legacybroadcast>";
      var endTag = "</legacybroadcast>";
      var start = content.IndexOf(startTag);
      string json = null;
      if (start >= 0)
      {
        this.xmlPrefix = content.Substring(0, start + startTag.Length);
        var end = content.IndexOf(endTag, start);
        if (end >= 0)
        {
          json = content.Substring(start + startTag.Length, end - start - startTag.Length);
          json = UnescapeXml(json);
          this.xmlSuffix = content.Substring(end);
        }
      }

      if (json == null)
        throw LoaderException.Fail($"File does not contain a {startTag}...{endTag} node");

      this.doc = JObject.Parse(json);
      LoadSatellites();
      LoadChannels();

      if (View.Default == null) // can't show dialog while unit-testing
        return;

      var dlg = View.Default.CreateActionBox(ChanSort.Loader.LG.Resource.LG_BlindscanInfo);
      dlg.AddAction(ChanSort.Loader.LG.Resource.LG_BlindscanInfo_OpenWebpage, 1);
      dlg.AddAction(ChanSort.Loader.LG.Resource.LG_BlindscanInfo_Continue, 2);
      dlg.AddAction(ChanSort.Loader.LG.Resource.LG_BlindscanInfo_Cancel, 0);
      while (true)
      {
        dlg.ShowDialog();
        switch (dlg.SelectedAction)
        {
          case 0:
            throw LoaderException.Fail(ChanSort.Loader.LG.Resource.LG_BlindscanInfo_Rejected);
          case 1:
            System.Diagnostics.Process.Start("https://github.com/PredatH0r/ChanSort/discussions/207");
            break;
          case 2:
            return;
        }
      }
    }
    #endregion

    #region UnescapeXml()
    private string UnescapeXml(string json)
    {
      var sb = new StringBuilder(json.Length);
      int i=0,j=0;
      for (i = json.IndexOf('&', j); i != -1; i = json.IndexOf('&', j))
      {
        sb.Append(json, j, i - j);
        j = json.IndexOf(';', i);
        var entity = json.Substring(i + 1, j - i - 1);
        switch (entity)
        {
          case "amp": sb.Append("&"); break;
          case "lt": sb.Append("<"); break;
          case "gt": sb.Append(">"); break;
          default:
            if (entity.StartsWith("#x"))
              sb.Append((char) int.Parse("0x" + entity.Substring(2), NumberStyles.AllowHexSpecifier));
            else if (entity.StartsWith("#"))
              sb.Append((char) int.Parse(entity.Substring(1)));
            else
              sb.Append("&").Append(entity).Append(";");
            break;
        }

        ++j;
      }

      sb.Append(json, j, json.Length - j);
      return sb.ToString();
    }
    #endregion

    #region EscapeXml()
    private string EscapeXml(string json)
    {
      var sb = new StringBuilder(json.Length);
      foreach (var c in json)
      {
        switch (c)
        {
          case '&': sb.Append("&amp;"); break;
          case '<': sb.Append("&lt;"); break;
          case '>': sb.Append("&gt;"); break;
          default:
            if (c < 32 && !char.IsWhiteSpace(c))
              sb.Append($"&#x{(int) c:x4}");
            else
              sb.Append(c);
            break;
        }
      }
      return sb.ToString();
    }
    #endregion

    #region LoadSatellites()
    private void LoadSatellites()
    {
      var satList = this.doc["satelliteList"];
      if (satList == null)
        return;
      foreach (var node in satList)
      {
        if (!(bool) node["tpListLoad"])
          continue;
        var id = int.Parse((string) node["satelliteId"]);
        var sat = new Satellite(id);
        sat.Name = (string) node["satelliteName"];
        sat.OrbitalPosition = (string) node["satLocation"];
        this.DataRoot.AddSatellite(sat);

        LoadTransponders(node["TransponderList"], sat);
      }
    }
    #endregion

    #region LoadTransponders()
    private void LoadTransponders(JToken transponderList, Satellite sat)
    {
      foreach (var node in transponderList)
      {
        var id = (sat.Id << 16) + (int)node["channelIdx"];
        var tp = new Transponder(id);
        tp.Satellite = sat;
        sat.Transponder.Add(id, tp);

        tp.FrequencyInMhz = (int) node["frequency"];
        tp.Number = (int) node["channelIdx"];
        var pol = ((string) node["polarization"]).ToLowerInvariant();
        tp.Polarity = pol.StartsWith("h") ? 'H' : pol.StartsWith("V") ? 'V' : '\0';
        tp.TransportStreamId = (int) node["TSID"];
        tp.OriginalNetworkId = (int)node["ONID"];
        tp.SymbolRate = (int) node["symbolRate"];
      }
    }
    #endregion

    #region LoadChannels()
    private void LoadChannels()
    {
      if (this.doc["channelList"] == null)
        throw LoaderException.Fail("JSON does not contain a channelList node");

      var dec = new DvbStringDecoder(this.DefaultEncoding);
      int i = 0;
      foreach (var node in this.doc["channelList"])
      {
        var ch = new GcChannel<JToken>(0, i++, node);
        var major = (int) node["majorNumber"];
        ch.Source = (string)node["sourceIndex"];
        if (ch.Source == "SATELLITE DIGITAL")
          ch.SignalSource |= SignalSource.DvbS;
        else if (ch.Source == "CABLE DIGITAL")
          ch.SignalSource |= SignalSource.DvbC;
        else if (ch.Source.Contains("ANTENNA DIGITAL"))
          ch.SignalSource |= SignalSource.DvbT;
        else if (ch.Source.Contains("ANTENNA ANALOG"))
          ch.SignalSource |= SignalSource.AnalogT;
        else if (ch.Source.Contains("CABLE ANALOG"))
          ch.SignalSource |= SignalSource.AnalogC;
        else
        {
          // TODO: add some log for skipped channels
          continue;
        }

        ch.IsDisabled = (bool) node["disabled"];
        ch.Skip = (bool) node["skipped"];
        ch.Lock = (bool)node["locked"];
        ch.Hidden = (bool) node["Invisible"];
        var nameBytes = Convert.FromBase64String((string) node["chNameBase64"]);
        dec.GetChannelNames(nameBytes, 0, nameBytes.Length, out var name, out var shortName);
        ch.ShortName = shortName;
        ch.Name = name;
        var chName = (string) node["channelName"];
        if (!string.IsNullOrWhiteSpace(chName)) // chNameBase64 may contain special characters without proper code page ID, so we prefer the UTF8 "channelName" if available
          ch.Name = chName;

        ch.TransportStreamId = (int)node["TSID"];

        if ((ch.SignalSource & SignalSource.Dvb) != 0)
        {
          var transSystem = (string) node["transSystem"];

          //if (int.TryParse((string) node["satelliteId"], out var satId))
          ch.Satellite = (string) node["satelliteId"]; //this.DataRoot.Satellites.TryGet(satId);
          ch.Encrypted = (bool) node["scrambled"];
          ch.FreqInMhz = (int) node["frequency"];
          if (ch.FreqInMhz >= 100000 && ch.FreqInMhz < 1000000) // DVBS is given in MHz, DVBC/T in kHz
            ch.FreqInMhz /= 1000;

          var tpId = (string) node["tpId"];
          if (tpId != null && tpId.Length == 10)
            ch.Transponder = this.DataRoot.Transponder.TryGet((int.Parse(tpId.Substring(0, 4)) << 16) + int.Parse(tpId.Substring(4))); // satId + freq, e.g. 0192126041

          ch.IsDeleted = (bool) node["deleted"];
          ch.PcrPid = (int) node["pcrPid"] & 0x1FFF;
          ch.AudioPid = (int) node["audioPid"] & 0x1FFF;
          ch.VideoPid = (int) node["videoPid"] & 0x1FFF;
          ch.ServiceId = (int) node["SVCID"];
          if (ch.ServiceId == 0)
            ch.ServiceId = (int) node["programNum"];
          ch.ServiceType = (int) node["serviceType"];
          ch.OriginalNetworkId = (int) node["ONID"];
          ch.SignalSource |= LookupData.Instance.IsRadioTvOrData(ch.ServiceType);
        }
        else
        {
          ch.ChannelOrTransponder = (string) node["TSID"];
          ch.SignalSource |= SignalSource.Tv;
        }


        if (ch.IsDeleted)
          ch.OldProgramNr = -1;
        else
        {
          ch.OldProgramNr = major;
          if ((major & 0x4000) != 0)
          {
            ch.OldProgramNr &= 0x3FFF;
            ch.SignalSource |= SignalSource.Radio;
          }
        }

        ch.AddDebug(node["minorNumber"]?.ToString());
        //ch.AddDebug(", userEditChNumber=" + node["userEditChNumber"]);

        var list = this.DataRoot.GetChannelList(ch.SignalSource);
        this.DataRoot.AddChannel(list, ch);
      }
    }
    #endregion

    // saving

    #region Save()
    public override void Save()
    {
      this.UpdateJsonDoc();

      var sb = new StringBuilder();
      sb.Append(xmlPrefix);

      using var sw = new StringWriter();
      var jw = new JsonTextWriter(sw);
      {
        doc.WriteTo(jw);
      }
      var json = EscapeXml(sw.ToString());
      sb.Append(json);
      sb.Append(xmlSuffix);
      File.WriteAllText(this.FileName, sb.ToString());
    }
    #endregion

    #region UpdateJsonDoc()
    private void UpdateJsonDoc()
    {
      foreach (var list in this.DataRoot.ChannelLists)
      {
        int radioMask = (list.SignalSource & SignalSource.Radio) != 0 ? 0x4000 : 0;
        var updateUserEditChNumber = ini.GetBool("set_userEditChNumber");
        foreach (var chan in list.Channels)
        {
          if (!(chan is GcChannel<JToken> ch))
            continue;
          var node = ch.Node;
          if (ch.IsNameModified)
          {
            node["channelName"] = ch.Name;
            node["chNameBase64"] = Convert.ToBase64String(Encoding.UTF8.GetBytes(ch.Name));
          }

          //node["deleted"] = ch.IsDeleted; // we don't support deleting in this serializer

          var nr = Math.Max(ch.NewProgramNr, 0) | radioMask; // radio channels have 0x4000 added to the majorNumber
          node["majorNumber"] = nr;
          node["skipped"] = ch.Skip;
          node["locked"] = ch.Lock;
          node["Invisible"] = ch.Hidden;
          if (this.Features.CanEditAudioPid)
            node["audioPid"] = ((int)node["audioPid"] & ~0x1FFF) | ch.AudioPid;

          // the only successfully imported file was one where these flags were NOT set by ChanSort
          // these flags do get set when changing numbers through the TV's menu, but then prevent further modifications, e.g. through an import
          if (updateUserEditChNumber && ch.NewProgramNr != Math.Max(ch.OldProgramNr, 0))
          {
            node["userEditChNumber"] = true;
            node["userSelCHNo"] = true;
          }

          //node["disableUpdate"] = true; // No-Go! This blocked the whole list and required a factory reset. Regardless of the setting, the TV showed wrong numbers.

          //node["factoryDefault"] = true; // an exported file after manually changing numbers through the TV-menu had all channels set to userEditChNumber=true, userSelCHNo=true, factoryDefault=true;
        }
      }
    }
    #endregion
  }

}