├── .gitignore
├── FcomClient.sln
├── FcomClient
├── App.config
├── FcomClient.Diagnostics
│ └── Logger.cs
├── FcomClient.FsdDetection
│ ├── ConnectionManager.cs
│ └── HardwareDevice.cs
├── FcomClient.FsdObject
│ ├── AbstractFsdPacket.cs
│ ├── FsdMessage.cs
│ ├── FsdPacket.cs
│ └── PrivateMessage.cs
├── FcomClient.Serialization
│ ├── ApiManager.cs
│ ├── ApiObjects
│ │ ├── ForwardedMessage.cs
│ │ ├── MessageForwardRequest.cs
│ │ └── ServerRegistration.cs
│ ├── FcomApiException.cs
│ └── MessageForwarder.cs
├── FcomClient.UI
│ └── FcomClient.cs
├── FcomClient.csproj
├── Properties
│ └── AssemblyInfo.cs
└── packages.config
├── LICENSE
└── README.md
/.gitignore:
--------------------------------------------------------------------------------
1 | # Visual Studio 2015/2017 cache/options directory
2 | .vs/
3 |
4 | # The packages folder can be ignored because of Package Restore
5 | **/[Pp]ackages/*
6 |
7 | bin/
8 | obj/
9 | Properties/
10 |
11 | *.csproj.user
--------------------------------------------------------------------------------
/FcomClient.sln:
--------------------------------------------------------------------------------
1 |
2 | Microsoft Visual Studio Solution File, Format Version 12.00
3 | # Visual Studio 15
4 | VisualStudioVersion = 15.0.28307.329
5 | MinimumVisualStudioVersion = 10.0.40219.1
6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FcomClient", "FcomClient\FcomClient.csproj", "{045D79BF-2195-4F88-9802-A9FA28FB0F9F}"
7 | EndProject
8 | Global
9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
10 | Debug|Any CPU = Debug|Any CPU
11 | Debug-params|Any CPU = Debug-params|Any CPU
12 | Release|Any CPU = Release|Any CPU
13 | EndGlobalSection
14 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
15 | {045D79BF-2195-4F88-9802-A9FA28FB0F9F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
16 | {045D79BF-2195-4F88-9802-A9FA28FB0F9F}.Debug|Any CPU.Build.0 = Debug|Any CPU
17 | {045D79BF-2195-4F88-9802-A9FA28FB0F9F}.Debug-params|Any CPU.ActiveCfg = Debug-params|Any CPU
18 | {045D79BF-2195-4F88-9802-A9FA28FB0F9F}.Debug-params|Any CPU.Build.0 = Debug-params|Any CPU
19 | {045D79BF-2195-4F88-9802-A9FA28FB0F9F}.Release|Any CPU.ActiveCfg = Release|Any CPU
20 | {045D79BF-2195-4F88-9802-A9FA28FB0F9F}.Release|Any CPU.Build.0 = Release|Any CPU
21 | EndGlobalSection
22 | GlobalSection(SolutionProperties) = preSolution
23 | HideSolutionNode = FALSE
24 | EndGlobalSection
25 | GlobalSection(ExtensibilityGlobals) = postSolution
26 | SolutionGuid = {EE2870C4-7418-44F7-9403-5ED5CCA9972F}
27 | EndGlobalSection
28 | EndGlobal
29 |
--------------------------------------------------------------------------------
/FcomClient/App.config:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.Diagnostics/Logger.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace FcomClient.Diagnostics
4 | {
5 | class Logger
6 | {
7 | ///
8 | /// Name of the log file.
9 | ///
10 | private string Filename = "log.txt";
11 |
12 | ///
13 | /// Default constructor. Saves all log messages to "log.txt".
14 | ///
15 | public Logger()
16 | {
17 |
18 | }
19 |
20 | ///
21 | /// Constructor for saving all log messages to a specific file.
22 | ///
23 | /// Name of file to save to
24 | public Logger(string Filename)
25 | {
26 | this.Filename = Filename;
27 | }
28 |
29 | ///
30 | /// Saves a log message to the specified file.
31 | /// The timestamp is automatically appended to the front of the message.
32 | ///
33 | ///
34 | public void Log(string msg)
35 | {
36 | // YYYY-MM-DD hh:mm:ssZ
37 | DateTime timestamp = DateTime.UtcNow;
38 | string logMessage = String.Format("{0}: {1}", timestamp.ToString("u"), msg);
39 | System.IO.File.AppendAllLines(Filename, new string[] { logMessage });
40 | }
41 |
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.FsdDetection/ConnectionManager.cs:
--------------------------------------------------------------------------------
1 | using System.Collections.Generic;
2 | using System.Net;
3 | using SharpPcap;
4 |
5 | namespace FcomClient.FsdDetection
6 | {
7 | ///
8 | /// Helper class for managing network connections.
9 | ///
10 | class ConnectionManager
11 | {
12 | public List Connections { get; set; }
13 |
14 | public ConnectionManager()
15 | {
16 | Connections = new List();
17 | Filter();
18 | }
19 |
20 | ///
21 | /// Helper method for filtering out irrelevant connections.
22 | ///
23 | private void Filter()
24 | {
25 | CaptureDeviceList devices = CaptureDeviceList.Instance;
26 |
27 | // Get list of IPs with which we can use to filter out some of the detected connections
28 | IPAddress[] localIps = Dns.GetHostAddresses(Dns.GetHostName());
29 |
30 | // Filter out connections
31 | int candidate = -1;
32 | int i = 0; // loop counter
33 | foreach (ICaptureDevice dev in devices)
34 | {
35 | string deviceDescription = dev.ToString();
36 | HardwareDevice h = new HardwareDevice(dev);
37 | h.Device = dev;
38 | if (h.IpAddresses.Count > 0) // ignore connections with no IP addresses
39 | {
40 | Connections.Add(new HardwareDevice(dev));
41 |
42 | // if it turns out there's only one candidate,
43 | // then we can directly select it without asking the user.
44 | candidate = i;
45 |
46 | }
47 | i++;
48 | }
49 | }
50 |
51 | // TODO
52 | public ICaptureDevice GetPotentialConnections()
53 | {
54 | return null;
55 | }
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.FsdDetection/HardwareDevice.cs:
--------------------------------------------------------------------------------
1 | using SharpPcap;
2 | using System;
3 | using System.Collections.Generic;
4 | using System.Net;
5 |
6 | namespace FcomClient.FsdDetection
7 | {
8 | ///
9 | /// A wrapper for SharpPcap's ICaptureDevice.
10 | ///
11 | class HardwareDevice
12 | {
13 | ///
14 | /// User-recognizable name of the device.
15 | /// This name is also used in the Windows Control Panel.
16 | /// (under Network and Internet > Network Connection)
17 | ///
18 | public string FriendlyName { get; }
19 |
20 | ///
21 | /// A brief description of the device.
22 | /// Tends to be prety verbose, however.
23 | /// (e.g. "Network Adapter 'Microsoft' on local host")
24 | ///
25 | public string Description { get; }
26 |
27 | ///
28 | /// MAC address of the hardware device.
29 | ///
30 | public string MacAddress { get; }
31 |
32 | ///
33 | /// List of IP addresses associated with the hardware device.
34 | ///
35 | public List IpAddresses { get; }
36 |
37 | ///
38 | /// The SharpPcap object representing the hardware device.
39 | ///
40 | public SharpPcap.ICaptureDevice Device { get; set; }
41 |
42 | ///
43 | /// Creates a HardwareDevice object based on its SharpPcap representation.
44 | ///
45 | ///
46 | public HardwareDevice(ICaptureDevice dev)
47 | {
48 | this.Device = dev;
49 | string input = dev.ToString();
50 | IpAddresses = new List();
51 |
52 | List detectedAddrs = new List();
53 | IPAddress[] localIps = Dns.GetHostAddresses(Dns.GetHostName());
54 |
55 | foreach (IPAddress ip in localIps)
56 | {
57 | string addr = ip.ToString();
58 |
59 | // scrub out the %xxx at the end (if present)
60 | int percentSignPos = addr.IndexOf("%");
61 | if (percentSignPos > 0)
62 | addr = addr.Substring(0, percentSignPos);
63 |
64 | detectedAddrs.Add(addr);
65 | }
66 |
67 | // break everything up so we can parse line-by-line
68 | string[] deviceFields = input.Split(new string[] { "\n" }, StringSplitOptions.RemoveEmptyEntries);
69 | foreach (string line in deviceFields)
70 | {
71 | if (line.StartsWith("FriendlyName"))
72 | {
73 | FriendlyName = line.Replace("FriendlyName: ", "");
74 | }
75 | else if (line.StartsWith("Description"))
76 | {
77 | Description = line.Replace("Description: ", "");
78 | }
79 | /* IP or MAC address
80 | Only add if the IP address here exists in the detected list
81 | (that is, the list returned by Dns.GetHostAddresses() )
82 | */
83 | else if (line.StartsWith("Addr:"))
84 | {
85 | string detectedIp = line.Replace("Addr: ", "");
86 |
87 | // MAC address
88 | if (detectedIp.Contains("HW addr: "))
89 | MacAddress = detectedIp.Replace("HW addr: ", "");
90 |
91 | // IP address
92 | if (detectedAddrs.Contains(detectedIp))
93 | IpAddresses.Add(detectedIp);
94 | }
95 |
96 | }
97 |
98 | }
99 |
100 | }
101 | }
102 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.FsdObject/AbstractFsdPacket.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace FcomClient.FsdObject
4 | {
5 | abstract class AbstractFsdPacket
6 | {
7 | ///
8 | /// The time at which the packet was received.
9 | ///
10 | public abstract DateTime Timestamp { get; set; }
11 |
12 | ///
13 | /// The original packet, minus the TCP headers.
14 | ///
15 | public abstract string PacketString { get; set; }
16 |
17 | ///
18 | /// The callsign of the station sending the packet.
19 | ///
20 | public abstract string Sender { get; set; }
21 |
22 | ///
23 | /// The callsign of the station recieving the packet.
24 | ///
25 | public abstract string Recipient { get; set; }
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.FsdObject/FsdMessage.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace FcomClient.FsdObject
4 | {
5 | class FsdMessage : FsdPacket
6 | {
7 | ///
8 | /// Contents of the message.
9 | ///
10 | public string Message { get; }
11 |
12 | public FsdMessage(DateTime timestamp, string packetString) : base(timestamp, packetString)
13 | {
14 | string[] contents = packetString.Split(':');
15 |
16 | // Parse message fields.
17 | // Format: #TM::
18 | for (int i = 0; i < contents.Length; i++)
19 | {
20 | switch (i)
21 | {
22 | case 0: // sender
23 | base.Sender = contents[0].Substring(3);
24 | break;
25 | case 1: // recipient
26 | // if it's a frequency message, it'll be addressed to "@xxyyy" (i.e. 1xx.yyy MHz)
27 | // Keep the "@" so that the server knows it's a frequency
28 | base.Recipient = contents[1];
29 | break;
30 | case 2: // message contents
31 | this.Message = contents[2];
32 | break;
33 | default: // message contents, if message contains colons
34 | this.Message += ":" + contents[i];
35 | break;
36 | }
37 | }
38 | }
39 |
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.FsdObject/FsdPacket.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace FcomClient.FsdObject
4 | {
5 | ///
6 | /// Representation of a FSD packet.
7 | ///
8 | class FsdPacket
9 | {
10 |
11 | ///
12 | /// The time at which the packet was received.
13 | ///
14 | public DateTime Timestamp { get; set; }
15 |
16 | ///
17 | /// The original packet, minus the TCP headers.
18 | ///
19 | public string PacketString { get; set; }
20 |
21 | ///
22 | /// The callsign of the station sending the packet.
23 | ///
24 | public string Sender { get; set; }
25 |
26 | ///
27 | /// The callsign of the station recieving the packet.
28 | ///
29 | public string Recipient { get; set; }
30 |
31 | ///
32 | /// Initializes an instance of FsdPacket.
33 | ///
34 | /// The time at which the packet was received.
35 | /// The FSD packet; e.g. "#TM..."
36 | public FsdPacket(DateTime timestamp, string packetString)
37 | {
38 | this.PacketString = packetString;
39 | this.Timestamp = timestamp;
40 | }
41 |
42 | // TODO: create constructor that accepts sender/recipient as parameter
43 |
44 | ///
45 | /// Constructor for a FsdPacket object.
46 | ///
47 | ///
48 | /// The time at which the packet was received.
49 | ///
50 | ///
51 | /// The raw IPv4 packet, as captured, including the header.
52 | ///
53 | public FsdPacket(DateTime timestamp, byte[] packetString)
54 | {
55 | int TCP_HEADER_SIZE = 54;
56 | this.Timestamp = timestamp;
57 |
58 | // first, chop off the header
59 | byte[] noHeader = new byte[packetString.Length - TCP_HEADER_SIZE];
60 | Buffer.BlockCopy(packetString, TCP_HEADER_SIZE, noHeader, 0, noHeader.Length);
61 |
62 | // then, convert to string and chop off the trailing newline
63 | this.PacketString = System.Text.Encoding.UTF8.GetString(noHeader).Trim();
64 |
65 | // it seems that the server will sometimes smush multiple FSD packets into a single TCP packet.
66 | // if this happens, break them up.
67 | // TODO
68 |
69 | // raise event if PM
70 | if (this.IsPrivateMessage() && OnMessageArrival != null)
71 | OnMessageArrival();
72 | }
73 |
74 | public bool IsPrivateMessage()
75 | {
76 | if (this.PacketString == null || this.PacketString.Length < 4)
77 | return false;
78 | else if (this.PacketString.Substring(0, 3).Equals("#TM"))
79 | return true;
80 | else
81 | return false;
82 | }
83 |
84 | public void GetPayload()
85 | {
86 |
87 | }
88 |
89 | public delegate void msgEventRaiser();
90 |
91 | public event msgEventRaiser OnMessageArrival;
92 |
93 | }
94 | }
95 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.FsdObject/PrivateMessage.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace FcomClient.FsdObject
4 | {
5 | class PrivateMessage : AbstractFsdPacket
6 | {
7 | public override DateTime Timestamp { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
8 | public override string PacketString { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
9 | public override string Sender { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
10 | public override string Recipient { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.Serialization/ApiManager.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using FcomClient.Serialization.ApiObjects;
4 | using RestSharp;
5 | using RestSharp.Deserializers;
6 |
7 | namespace FcomClient.Serialization
8 | {
9 | ///
10 | /// A wrapper for the FCOM server API.
11 | ///
12 | class ApiManager
13 | {
14 | ///
15 | /// User agent string to use.
16 | ///
17 | private readonly string CLIENT_VERSION = "FcomClient/0.9.2";
18 |
19 | ///
20 | /// Server address, read from the file server_location.txt
21 | ///
22 | public readonly string SERVER_ADDRESS = System.IO.File.ReadAllText("server_location.txt");
23 |
24 | ///
25 | /// API endpoint for submitting messages to be forwarded.
26 | ///
27 | private readonly string MESSAGE_FORWARDING_ENDPOINT = "/api/v1/messaging";
28 |
29 | ///
30 | /// API endpoint for registering/confirming a token.
31 | ///
32 | public readonly string REGISTRATION_ENDPOINT = "/api/v1/register";
33 |
34 | ///
35 | /// API registration token, provided by the bot and entered into FcomClient by the user.
36 | ///
37 | public string Token { get; set; }
38 |
39 | ///
40 | /// The online callsign the user is logged in as.
41 | ///
42 | public string Callsign;
43 |
44 | ///
45 | /// ID number of the Discord user associated with the token.
46 | ///
47 | public long DiscordId { get; }
48 |
49 | ///
50 | /// Display name of the Discord user associated with the token.
51 | ///
52 | public string DiscordName { get; }
53 |
54 | ///
55 | /// Internal object for interacting with the FCOM server API.
56 | ///
57 | private RestClient client;
58 |
59 | ///
60 | /// Whether the callsign/token associated with the ApiManager object is registered.
61 | ///
62 | public bool IsRegistered { get; }
63 |
64 | ///
65 | /// Initializes the API manager,
66 | /// passing the given token to the server for confirmation.
67 | ///
68 | public ApiManager(string token, string callsign)
69 | {
70 | client = new RestClient(SERVER_ADDRESS);
71 | RestRequest registerRequest
72 | = new RestRequest(REGISTRATION_ENDPOINT, Method.GET);
73 |
74 | client.UserAgent = CLIENT_VERSION;
75 |
76 | registerRequest.AddParameter("token", token);
77 | registerRequest.AddParameter("callsign", callsign);
78 |
79 | registerRequest.OnBeforeDeserialization = resp => { resp.ContentType = "application/json"; };
80 |
81 | var response = client.Execute(registerRequest);
82 |
83 | if (response.IsSuccessful)
84 | {
85 | var deserializer = new JsonDeserializer();
86 | ServerRegistrationResponse returnPayload = deserializer.Deserialize(response);
87 |
88 | this.Callsign = returnPayload.Callsign;
89 | this.DiscordId = returnPayload.DiscordId;
90 | this.DiscordName = returnPayload.DiscordName;
91 | this.Token = returnPayload.Token;
92 |
93 | if (this.DiscordId == 0)
94 | this.IsRegistered = false;
95 | else
96 | this.IsRegistered = true;
97 | }
98 | else
99 | {
100 | // do nothing
101 | }
102 |
103 | }
104 |
105 | ///
106 | /// Forwards the given FSD message to the FCOM server.
107 | ///
108 | /// Message to forward.
109 | public void ForwardMessage(FsdObject.FsdMessage pm)
110 | {
111 | // convert timestamp to Unix time
112 | DateTimeOffset dateTimeOffset = new DateTimeOffset(pm.Timestamp);
113 | long unixTimestamp = dateTimeOffset.ToUnixTimeMilliseconds();
114 |
115 | /* Sample JSON (after server rewrite):
116 | NOTE: currently, the API does not parse beyond the first message.
117 | {
118 | "token": "Wjve5p45aTojv6yzRr72FKs9K1py8ze2auFbB8g328o",
119 | "messages": [
120 | {
121 | "timestamp": "2018-05-01 10:40:00 PM",
122 | "sender": "XX_SUP",
123 | "receiver": "DAL1107",
124 | "message": "IMMA SWING ZE MIGHTY BAN-HAMMER MUAHAHAHAHA"
125 | }
126 | ]
127 | }
128 | */
129 |
130 | Console.Write(" -- Forwarding to {0}...", SERVER_ADDRESS);
131 |
132 | // Build the API request
133 | var request = new RestRequest(MESSAGE_FORWARDING_ENDPOINT, Method.POST)
134 | {
135 | RequestFormat = DataFormat.Json
136 | };
137 |
138 | // Build the JSON object
139 | var messagePayload = new Message
140 | {
141 | timestamp = unixTimestamp.ToString(),
142 | sender = pm.Sender,
143 | receiver = pm.Recipient,
144 | message = pm.Message,
145 | };
146 |
147 | /* The API accepts a list of messages, but currently only processes the first in the list*/
148 | var messageList = new List
149 | {
150 | messagePayload
151 | };
152 |
153 | request.AddBody(new ForwardedMessage
154 | {
155 | token = this.Token,
156 | messages = messageList
157 | });
158 |
159 | IRestResponse response = client.Execute(request);
160 | var content = response.Content;
161 |
162 | if (response.IsSuccessful)
163 | {
164 | }
165 | else
166 | {
167 | throw new FcomApiException(String.Format("[Message forwarding error] {0}", response.Content));
168 | }
169 |
170 | }
171 | }
172 | }
173 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.Serialization/ApiObjects/ForwardedMessage.cs:
--------------------------------------------------------------------------------
1 | using System.Collections.Generic;
2 |
3 | namespace FcomClient.Serialization.ApiObjects
4 | {
5 | public class ForwardedMessage
6 | {
7 | public string token { get; set; }
8 | public List messages { get; set; }
9 | }
10 |
11 | public class Message
12 | {
13 | public string timestamp { get; set; }
14 | public string sender { get; set; }
15 | public string receiver { get; set; }
16 | public string message { get; set; }
17 | }
18 |
19 | }
20 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.Serialization/ApiObjects/MessageForwardRequest.cs:
--------------------------------------------------------------------------------
1 | using System.Collections.Generic;
2 | using RestSharp.Serializers;
3 |
4 | namespace FcomClient.Serialization.ApiObjects
5 | {
6 | ///
7 | /// Represents a message forwarding request.
8 | ///
9 | class MessageForwardRequest
10 | {
11 | [SerializeAs(Name ="token")]
12 | public string Token { get; set; }
13 |
14 | [SerializeAs(Name = "discord_id")]
15 | public long DiscordId { get; set; }
16 |
17 | [SerializeAs(Name = "messages")]
18 | public List Messages { get; set; }
19 |
20 | public MessageForwardRequest(string token, long discordId)
21 | {
22 | this.Token = token;
23 | this.DiscordId = discordId;
24 | }
25 |
26 | public void AppendMessage()
27 | {
28 |
29 | }
30 | }
31 |
32 | class TextMessage {
33 |
34 | [SerializeAs(Name = "timestamp")]
35 | public string Timestamp { get; set; }
36 |
37 | [SerializeAs(Name = "sender")]
38 | public string Sender { get; set; }
39 |
40 | [SerializeAs(Name = "recipient")]
41 | public string Recipient { get; set; }
42 |
43 | [SerializeAs(Name = "message")]
44 | public string Message { get; set; }
45 | }
46 |
47 | }
48 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.Serialization/ApiObjects/ServerRegistration.cs:
--------------------------------------------------------------------------------
1 | using RestSharp.Deserializers;
2 |
3 | namespace FcomClient.Serialization.ApiObjects
4 | {
5 | ///
6 | /// Represents API response containing the server registration.
7 | ///
8 | class ServerRegistrationResponse
9 | {
10 | [DeserializeAs(Name = "token")]
11 | public string Token { get; set; }
12 |
13 | [DeserializeAs(Name = "callsign")]
14 | public string Callsign { get; set; }
15 |
16 | [DeserializeAs(Name = "discord_id")]
17 | public long DiscordId { get; set; }
18 |
19 | [DeserializeAs(Name = "discord_name")]
20 | public string DiscordName { get; set; }
21 |
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.Serialization/FcomApiException.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace FcomClient.Serialization
4 | {
5 | class FcomApiException : Exception
6 | {
7 | public FcomApiException()
8 | {
9 | }
10 |
11 | public FcomApiException(string message) : base(message)
12 | {
13 | }
14 |
15 | public FcomApiException(string message, Exception inner) : base(message, inner)
16 | {
17 | }
18 |
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.Serialization/MessageForwarder.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using RestSharp;
3 | using FcomClient.FsdObject;
4 |
5 | namespace FcomClient.Serialization
6 | {
7 | class MessageForwarder
8 | {
9 | ///
10 | /// Server address, read from the file server_location.txt
11 | ///
12 | private readonly string SERVER_ADDRESS = System.IO.File.ReadAllText("server_location.txt");
13 |
14 | ///
15 | /// API endpoint for submitting messages to be forwarded.
16 | ///
17 | private readonly string MESSAGE_FORWARDING_ENDPOINT = "messaging";
18 |
19 | ///
20 | /// API registration token. This hasn't been implemented yet, so for now it's just the build number.
21 | ///
22 | private string TOKEN = "20180626";
23 |
24 | private RestClient client;
25 |
26 | public MessageForwarder()
27 | {
28 | client = new RestClient(SERVER_ADDRESS);
29 | }
30 |
31 | ///
32 | /// Uploads a message to the API for forwarding via Discord.
33 | ///
34 | ///
35 | public void UploadMessage(FsdMessage pm)
36 | {
37 | // convert timestamp to Unix time
38 | DateTimeOffset dateTimeOffset = new DateTimeOffset(pm.Timestamp);
39 | long unixTimestamp = dateTimeOffset.ToUnixTimeMilliseconds();
40 |
41 | // Sorry for the ugly and messy-looking JSON :(
42 | string json = string.Format(
43 | "{{\"privateMessage\":{{\"token\":\"{0}\",\"timestamp\":\"{1}\",\"sender\":\"{2}\",\"receiver\":\"{3}\",\"message\":\"{4}\"}}}}",
44 | TOKEN, unixTimestamp, pm.Sender, pm.Recipient, pm.Message);
45 | Console.WriteLine("-- Forwarding to " + SERVER_ADDRESS);
46 | Console.WriteLine("-- " + json);
47 |
48 | var request = new RestRequest(MESSAGE_FORWARDING_ENDPOINT, Method.POST);
49 | request.AddParameter("application/json", json, ParameterType.RequestBody);
50 |
51 | IRestResponse response = client.Execute(request);
52 | var content = response.Content;
53 |
54 | // TODO: handle API response (success / error etc)
55 | }
56 |
57 | }
58 | }
59 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.UI/FcomClient.cs:
--------------------------------------------------------------------------------
1 | using FcomClient.FsdDetection;
2 | using FcomClient.Diagnostics;
3 | using System;
4 | using System.Collections.Generic;
5 | using SharpPcap;
6 | using FcomClient.Serialization;
7 | using FcomClient.FsdObject;
8 | using System.Text.RegularExpressions;
9 | using System.Runtime.InteropServices; // for hiding the console window
10 | using System.IO.Pipes;
11 |
12 | namespace FcomClient.UI
13 | {
14 | class FcomClient
15 | {
16 | // The following DLLImports are for hiding the console window
17 | [DllImport("kernel32.dll")]
18 | static extern IntPtr GetConsoleWindow();
19 | [DllImport("user32.dll")]
20 | static extern bool ShowWindow(IntPtr hWnd, int nCmdShow);
21 |
22 | static string callsign = "";
23 | static ApiManager am;
24 | static Logger logger = new Logger(); // log.txt
25 |
26 | static NamedPipeClientStream namedPipeClient; // named pipe to FcomGui
27 | static readonly string FCOM_GUI_PIPE = "ca.norrisng.fcom";
28 |
29 | ///
30 | /// Main function
31 | ///
32 | ///
33 | ///
34 | /// (Optional)
35 | /// Callsign (args[0]) and verification code (args[1]).
36 | /// If not provided, the user is prompted to enter them via the commandline interface.
37 | ///
38 | static void Main(string[] args)
39 | {
40 | // Callsign + verification code provided via arguments
41 | bool isStartedWithArgs = (args.Length == 2);
42 |
43 | try {
44 | logger.Log("Starting FcomClient...");
45 |
46 | bool isInputValid = false;
47 | Regex callsignFormat = new Regex(@"^(\d|\w|_|-)+$");
48 |
49 | // Callsign + verification code provided via arguments
50 | if (isStartedWithArgs)
51 | {
52 | // Connect to GUI via named pipe
53 | namedPipeClient = new NamedPipeClientStream(FCOM_GUI_PIPE);
54 | namedPipeClient.Connect();
55 |
56 | if (callsignFormat.IsMatch(args[0]))
57 | {
58 | isInputValid = true;
59 | callsign = args[0];
60 |
61 | logger.Log(String.Format("Client was started with the following arguments: {0} {1}", args[0], args[1]));
62 |
63 | am = new ApiManager(args[1], callsign);
64 |
65 | if (!am.IsRegistered)
66 | {
67 | logger.Log("[FCOM_API_ERROR] Couldn't register with API");
68 | SendPipeMessage(namedPipeClient, "FCOM_API_ERROR");
69 | }
70 | }
71 | else
72 | {
73 | // if invalid callsign format, ask the user via the command-line interface
74 | isInputValid = false;
75 | SendPipeMessage(namedPipeClient, "FCOM_CLIENT_BAD_CALLSIGN");
76 | }
77 |
78 | }
79 |
80 | // ask user for callsign + verification code,
81 | // if not provided via args, or if args were invalid
82 | if (!isInputValid) {
83 |
84 | bool isRegistered = false;
85 | while (!isRegistered)
86 | {
87 |
88 | while (!isInputValid)
89 | {
90 | Console.Write("\nPlease enter your exact callsign, then press Enter: ");
91 | callsign = Console.ReadLine();
92 |
93 | if (callsignFormat.IsMatch(callsign))
94 | isInputValid = true;
95 | else
96 | Console.WriteLine("Invalid callsign!");
97 | }
98 |
99 | Console.Write("\nPlease enter the verification code from Discord, then press Enter:\n");
100 | string token = Console.ReadLine();
101 |
102 | logger.Log(String.Format("Callsign: \"{0}\", Token: \"{1}\"", callsign, token));
103 |
104 | Console.WriteLine("\nRegistering token with Discord bot...");
105 | am = new ApiManager(token, callsign);
106 | logger.Log(String.Format("Register at {0}{1}", am.SERVER_ADDRESS, am.REGISTRATION_ENDPOINT));
107 |
108 | isRegistered = am.IsRegistered;
109 | if (isRegistered)
110 | {
111 | Console.WriteLine("Registered {0} to Discord user {1} ({2})", callsign, am.DiscordName, am.DiscordId);
112 | }
113 | else
114 | Console.WriteLine("Couldn't register! You've either entered the incorrect code," +
115 | " or the server isn't responding.");
116 | }
117 |
118 | }
119 |
120 | Console.Write("\nDetecting connections...\n\n");
121 | ConnectionManager cm = new ConnectionManager();
122 | List connections = cm.Connections;
123 |
124 | // TODO: completely decouple SharpPcap from the UI
125 |
126 | // Provide GUI with list of detected connections and wait for user response
127 | //ExternalGuiManager ext = new ExternalGuiManager();
128 | //ICaptureDevice device = ext.GetHardwareDevice(connections).Device; // BLOCKING CALL
129 |
130 | ICaptureDevice device;
131 |
132 | // Auto-select the only connection available
133 | if (connections.Count == 1)
134 | {
135 | device = connections[0].Device;
136 |
137 | // No additional user input needed - close the console window if opened via GUI
138 | if (isStartedWithArgs)
139 | {
140 | ShowWindow(GetConsoleWindow(), 0);
141 | logger.Log("Hiding console window");
142 | }
143 |
144 | }
145 | // Otherwise, prompt the user for the correct one
146 | else
147 | {
148 | int i = 0;
149 | foreach (HardwareDevice h in connections)
150 | {
151 | Console.WriteLine("({0})", i);
152 | Console.WriteLine("------");
153 | Console.WriteLine("Name: {0}\nDescription: {1}", h.FriendlyName, h.Description);
154 | Console.WriteLine("IP addresses:");
155 | foreach (string s in h.IpAddresses)
156 | {
157 | // print detected IPs
158 | Console.WriteLine("\t" + s);
159 | }
160 | i++;
161 | }
162 |
163 | bool parseSuccess = false;
164 | int deviceNumber = -1;
165 | Console.WriteLine("\nWhich of the above is your internet connection?");
166 |
167 | // Ignore invalid inputs
168 | while (deviceNumber < 0 || deviceNumber >= connections.Count || !parseSuccess)
169 | {
170 | Console.Write("Enter the corresponding number: ");
171 | parseSuccess = Int32.TryParse(Console.ReadLine(), out deviceNumber);
172 | }
173 |
174 | device = connections[deviceNumber].Device;
175 |
176 | }
177 |
178 | // force a wait so that the user can see what's happening
179 | System.Threading.Thread.Sleep(700);
180 |
181 | // register event handler
182 | device.OnPacketArrival +=
183 | new SharpPcap.PacketArrivalEventHandler(OnIncomingFsdPacket);
184 |
185 | // open device for capturing
186 | int readTimeoutMilliseconds = 2000;
187 | device.Open(DeviceMode.Normal, readTimeoutMilliseconds);
188 |
189 | // set filter to tcp port 6809
190 | device.Filter = "tcp port 6809";
191 |
192 | // Hide console window
193 | if (isStartedWithArgs)
194 | {
195 | logger.Log("Hiding console window");
196 | ShowWindow(GetConsoleWindow(), 0);
197 | }
198 |
199 | Console.WriteLine("\nYou may now minimize this window. To quit, simply close it.");
200 | Console.WriteLine("When you're done, close this window and send \"remove\" to the Discord bot!\n\n");
201 |
202 | logger.Log("Starting FSD capture...");
203 |
204 | // Start capturing packets indefinitely
205 | device.Capture();
206 |
207 | // note: this line is uncreachable, since we're capturing indefinitely
208 | device.Close();
209 | }
210 | catch (Exception ex)
211 | {
212 | // Dump stack trace to logfile
213 | logger.Log("[CRASH] " + ex.ToString());
214 |
215 | Console.WriteLine("\nFcomClient has crashed! Please see log.txt for error details.\n");
216 |
217 | if (args.Length == 0)
218 | {
219 | Console.WriteLine("Press any key to exit...");
220 | Console.ReadKey();
221 | }
222 | else if (isStartedWithArgs)
223 | {
224 | // Notify GUI of crash
225 | byte[] messageBytes = System.Text.Encoding.UTF8.GetBytes("FCOM_CLIENT_CRASH");
226 | namedPipeClient.Write(messageBytes, 0, messageBytes.Length);
227 | }
228 | }
229 | }
230 | ///
231 | /// Event handler for incoming FSD packets.
232 | ///
233 | ///
234 | ///
235 | static void OnIncomingFsdPacket(object sender, CaptureEventArgs e)
236 | {
237 | DateTime timestamp = DateTime.Now;
238 |
239 | // FsdPacket trims the newline, so we have to grab the byte[] ourselves
240 | string pktString = System.Text.Encoding.UTF8.GetString(e.Packet.Data);
241 |
242 | string[] inputs = pktString.Split(new String[] { "\n" }, StringSplitOptions.None);
243 | foreach (string line in inputs)
244 | {
245 | // Strip out the garbage that appears in between FSD packets
246 | string input = Regex.Replace(line, "^.*\\$", "$", RegexOptions.Multiline);
247 | input = Regex.Replace(input, "^.*#", "#", RegexOptions.Multiline);
248 | input = Regex.Replace(input, "^.*%", "%", RegexOptions.Multiline);
249 | input = Regex.Replace(input, "^.*@", "@", RegexOptions.Multiline);
250 |
251 | // First, create a FsdPacket object from the packet
252 | FsdPacket currPacket = new FsdPacket(timestamp, input);
253 |
254 | if (input.StartsWith("#TM"))
255 | {
256 | FsdMessage input_pm = new FsdMessage(timestamp, input);
257 | }
258 | }
259 |
260 | // First, create a FsdPacket object from the packet
261 | FsdPacket pkt = new FsdPacket(timestamp, e.Packet.Data);
262 |
263 | // Only do something if it's a PM
264 | if (pkt.PacketString.StartsWith("#TM"))
265 | {
266 | FsdMessage pm = new FsdMessage(timestamp, pkt.PacketString);
267 |
268 | if (IsForwardMessage(pm))
269 | {
270 | string loggingString = String.Format("{0} > {1} ({2}):\"{3}\" ",
271 | pm.Sender,
272 | pm.Recipient,
273 | pm.Timestamp.ToUniversalTime(),
274 | pm.Message);
275 | Console.WriteLine(loggingString);
276 | logger.Log(String.Format("<{0}>", pkt.PacketString));
277 | logger.Log(loggingString);
278 |
279 | try
280 | {
281 | am.ForwardMessage(pm);
282 | }
283 | catch (FcomApiException ex)
284 | {
285 | logger.Log(ex.Message);
286 | }
287 |
288 | // Do not forward messages sent over the frequency, that aren't addressed to the user
289 | //if (pm.Message.StartsWith(callsign))
290 | // am.ForwardMessage(pm);
291 | }
292 |
293 | }
294 |
295 | }
296 |
297 | ///
298 | /// Helper method for determining if a FsdMessage should be forwarded.
299 | ///
300 | /// The FsdMessage in question
301 | /// True if it should be forwarded, False otherwise
302 | static private bool IsForwardMessage(FsdMessage msg)
303 | {
304 | // Under-the-hood ones to SERVER/FP/DATA...
305 | bool isServerMessage =
306 | string.Equals(msg.Sender, "server", StringComparison.OrdinalIgnoreCase) ||
307 | string.Equals(msg.Recipient, "server", StringComparison.OrdinalIgnoreCase) ||
308 | string.Equals(msg.Recipient, "fp", StringComparison.OrdinalIgnoreCase) ||
309 | string.Equals(msg.Recipient, "data", StringComparison.OrdinalIgnoreCase)
310 | ;
311 |
312 | // on-frequency and private messages addressed to the user...
313 |
314 | // (NOTE: using string.StartsWith() results in partial matches (e.g. UAL1/UAL123), so use regex instead)
315 | // Regex: ^{callsign}( |,).*
316 | Regex frequencyMessagePattern = new Regex("^" + callsign + @"( |,).*", RegexOptions.IgnoreCase);
317 | bool isAddressedToUser = frequencyMessagePattern.IsMatch(msg.Message) ||
318 | string.Equals(msg.Recipient, callsign, StringComparison.OrdinalIgnoreCase);
319 |
320 | // self-addressed messages:
321 | bool isSelfMessage = string.Equals(msg.Sender, callsign, StringComparison.OrdinalIgnoreCase);
322 |
323 | return !isServerMessage && isAddressedToUser && !isSelfMessage;
324 | }
325 |
326 | ///
327 | /// Helper function for sending a message to the GUI.
328 | ///
329 | /// Connected named pipe client stream
330 | /// The message to send to the GUI.
331 | private static void SendPipeMessage(NamedPipeClientStream pipe, string message)
332 | {
333 | byte[] messageBytes = System.Text.Encoding.UTF8.GetBytes(message);
334 | namedPipeClient.Write(messageBytes, 0, messageBytes.Length);
335 | }
336 |
337 | }
338 | }
339 |
--------------------------------------------------------------------------------
/FcomClient/FcomClient.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Debug
6 | AnyCPU
7 | {045D79BF-2195-4F88-9802-A9FA28FB0F9F}
8 | Exe
9 | Properties
10 | FcomClient
11 | FcomClient
12 | v4.7.1
13 | 512
14 | true
15 |
16 | publish\
17 | true
18 | Disk
19 | false
20 | Foreground
21 | 7
22 | Days
23 | false
24 | false
25 | true
26 | 0
27 | 1.0.0.%2a
28 | false
29 | false
30 | true
31 |
32 |
33 | AnyCPU
34 | true
35 | full
36 | false
37 | bin\Debug\
38 | DEBUG;TRACE
39 | prompt
40 | 4
41 |
42 |
43 | AnyCPU
44 | pdbonly
45 | true
46 | bin\Release\
47 | TRACE
48 | prompt
49 | 4
50 |
51 |
52 | true
53 | bin\Debug-params\
54 | DEBUG;TRACE
55 | full
56 | AnyCPU
57 | prompt
58 | MinimumRecommendedRules.ruleset
59 | true
60 |
61 |
62 |
63 | ..\packages\PacketDotNet.0.16.0\lib\PacketDotNet.dll
64 |
65 |
66 | ..\packages\RestSharp.106.3.1\lib\net452\RestSharp.dll
67 |
68 |
69 | ..\packages\SharpPcap.4.5.0\lib\netstandard2.0\SharpPcap.dll
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
100 | Designer
101 |
102 |
103 |
104 |
105 |
106 | False
107 | Microsoft .NET Framework 4.7.1 %28x86 and x64%29
108 | true
109 |
110 |
111 | False
112 | .NET Framework 3.5 SP1
113 | false
114 |
115 |
116 |
117 |
124 |
--------------------------------------------------------------------------------
/FcomClient/Properties/AssemblyInfo.cs:
--------------------------------------------------------------------------------
1 | using System.Reflection;
2 | using System.Runtime.CompilerServices;
3 | using System.Runtime.InteropServices;
4 |
5 | // General Information about an assembly is controlled through the following
6 | // set of attributes. Change these attribute values to modify the information
7 | // associated with an assembly.
8 | [assembly: AssemblyTitle("FcomClient")]
9 | [assembly: AssemblyDescription("")]
10 | [assembly: AssemblyConfiguration("")]
11 | [assembly: AssemblyCompany("")]
12 | [assembly: AssemblyProduct("FcomClient")]
13 | [assembly: AssemblyCopyright("Norris Ng")]
14 | [assembly: AssemblyTrademark("")]
15 | [assembly: AssemblyCulture("")]
16 |
17 | // Setting ComVisible to false makes the types in this assembly not visible
18 | // to COM components. If you need to access a type in this assembly from
19 | // COM, set the ComVisible attribute to true on that type.
20 | [assembly: ComVisible(false)]
21 |
22 | // The following GUID is for the ID of the typelib if this project is exposed to COM
23 | [assembly: Guid("045d79bf-2195-4f88-9802-a9fa28fb0f9f")]
24 |
25 | // Version information for an assembly consists of the following four values:
26 | //
27 | // Major Version
28 | // Minor Version
29 | // Build Number
30 | // Revision
31 | //
32 | // You can specify all the values or you can default the Build and Revision Numbers
33 | // by using the '*' as shown below:
34 | [assembly: AssemblyVersion("0.9.2")]
35 | //[assembly: AssemblyFileVersion("0.9.2")]
36 |
--------------------------------------------------------------------------------
/FcomClient/packages.config:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # FCOM client #
2 |
3 | The client that capture messages received over VATSIM / IVAO
4 |
5 | Version 0.9.2
6 |
7 | ## Requirements ##
8 |
9 | * Windows 7 or newer
10 | * .NET Framework 4.7.1 or newer
11 | * [WinPcap](https://www.winpcap.org/)
12 |
13 |
14 |
15 | ## Download and installation ##
16 |
17 | See the [Releases page on GitHub](https://github.com/norrisng/FcomClient/releases) for downloads.
18 |
19 | To install:
20 |
21 | * Extract the FcomClient folder to any desired location
22 | * Run the included WinPcap installer (if not already installed)
23 |
24 | To run:
25 |
26 | * Open `FcomGui.exe` (the one with the purple "F" icon)
27 | * Alternatively, open `FcomClient.exe` for the older "console" interface
28 |
29 |
30 |
31 | ## For developers: GUI source code ##
32 |
33 | `FcomClient` (this repo) currently only contains a command-line interface.
34 |
35 | For now, the GUI is implemented via a standalone program. [Its source code can be found here.](https://github.com/norrisng/FcomGui)
36 |
37 |
38 |
39 | ## More info ##
40 |
41 | Website: https://norrisng.ca/fcom
42 |
43 | Discord server: https://discord.gg/F59CyKC
44 |
45 | Dev blog: https://fcomforwarder.wordpress.com/
46 |
--------------------------------------------------------------------------------