SummerofCode Orfest - Revision history

Egallager: link cleanup

2023-05-05T19:11:59Z

link cleanup

Egallager: fix heading levels

2023-05-05T19:09:33Z

fix heading levels

Esr: Hide historical instance of "Subversion" from mediawiki search to avoid false positives.

2013-03-20T23:14:29Z

Hide historical instance of "Subversion" from mediawiki search to avoid false positives.

Esr: Hide historical instance of "SVN" from mediawiki search to avoid false positives.

2013-03-20T23:12:08Z

Hide historical instance of "SVN" from mediawiki search to avoid false positives.

Orfest at 15:42, 15 April 2010

2010-04-15T15:42:37Z

Crab: /* SoC Application */

2010-04-09T22:11:28Z

‎SoC Application

Crab at 19:24, 8 April 2010

2010-04-08T19:24:23Z

Ivanovic: add link to SoC application

2010-04-08T10:19:30Z

add link to SoC application

Orfest: patches added

2010-04-07T04:43:03Z

patches added

Orfest at 07:40, 5 April 2010

2010-04-05T07:40:43Z

@@ Line 15: / Line 15: @@
 ==Questionnaire==
 March, 22. Committed a [https://gna.org/patch/index.php?1548 patch] fixing the statistics uploader.
 April, 7. Commited another [https://gna.org/patch/index.php?1597 path] adding proxy support with no and basic authentication to the statistics uploader.
-Please, see answers to the [http://wiki.wesnoth.org/SoC_Ideas_Network_Stack_Rewrite#Questions questions] about the network stack project at the [http://wiki.wesnoth.org/index.php?title=SummerofCode_Orfest#6.29_Answers bottom] of this page.
+Please, see answers to the [[SoC_Ideas_Network_Stack_Rewrite#Questions|questions]] about the network stack project at the [[SummerofCode_Orfest#6.29_Answers|bottom]] of this page.
 <h4>1.1) Write a small introduction to yourself.</h4>
@@ Line 159: / Line 158: @@
 <h4>4.5) Include as much technical detail about your implementation as you can</h4>
-Please see the section of answers [http://wiki.wesnoth.org/index.php?title=SummerofCode_Orfest#6.29_Answers below]
+Please see the section of answers [[SummerofCode_Orfest#6.29_Answers|below]].
 <h4>4.6) What do you expect to gain from this project?</h4>

@@ Line 1: / Line 1: @@
 {{SoC2010Student_2|orfest|SoC Ideas Network Stack Rewrite}}
-[[Category:SoC Ideas Network Stack Rewrite]]
+==Description==
 <h4>Orfest - Rewriting network stack</h4>
 gna.org : orfest <br>
@@ Line 10: / Line 8: @@
 Please see more details on my page.
-=IRC=
+==IRC==
 orfest
-=SoC Application=
+==SoC Application==
 [http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/nkurtov/t127014587273 Rewriting network stack using boost::asio]
-=Questionnaire=
+==Questionnaire==
 March, 22. Committed a [https://gna.org/patch/index.php?1548 patch] fixing the statistics uploader.
@@ Line 357: / Line 355: @@
 . Major buildfiles changes to build a dynamic library (wesnoth_client_network.so/.dll) and link client against it<br/>

@@ Line 172: / Line 172: @@
 <h4>5.1) Are you familiar with any of the following tools or languages?</h4>
-     * Subversion (used for all commits)
+     * Sub&shy;&shy;version (used for all commits)
 Yes, we are using S&shy;&shy;V&shy;&shy;N in our project at Intel
      * C++ (language used for all the normal source code)

@@ Line 98: / Line 98: @@
 Frankly speaking, I've been playing Wesnoth just for several hours and haven't tried multiplayer. But I'm looking forward to complete a campaign and then go playing on the internet.
-<h4>2.6) If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4>
+<h4>2.6) If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our S&shy;&shy;V&shy;&shy;N (during the evaluation period or earlier) please state so.</h4>
 March, 22. Committed a [https://gna.org/patch/index.php?1548 patch] fixing the statistics uploader.
 April, 7. Commited another [https://gna.org/patch/index.php?1597 path] adding proxy support with no and basic authentication to the statistics uploader.
@@ Line 173: / Line 173: @@
 <h4>5.1) Are you familiar with any of the following tools or languages?</h4>
      * Subversion (used for all commits)
-Yes, we are using SVN in our project at Intel
+Yes, we are using S&shy;&shy;V&shy;&shy;N in our project at Intel
      * C++ (language used for all the normal source code)
 Yes, I've been coding on C++ for 5 years. All ACM competitions I also write using C++.

← Older revision		Revision as of 15:42, 15 April 2010
Line 233:		Line 233:
	The design is critical in this task. A not-good-enough design can neglect results of all the task.		The design is critical in this task. A not-good-enough design can neglect results of all the task.
	Another risk is unsufficient network code testing. I desperately believe that boost is absolutely portable, but it doesn't make testing unnecessary. Rewriting such a low-level code is dangerous to introduce regressions.		Another risk is unsufficient network code testing. I desperately believe that boost is absolutely portable, but it doesn't make testing unnecessary. Rewriting such a low-level code is dangerous to introduce regressions.
		+
		+
		+	<h3></h3>
		+	<h4>Functional requirements:</h4>
		+	0. Support existing functionality<br/>
		+	1. Proxy<br/>
		+	2. Timeouts <br/>
		+	3. Encapsulated in a single object<br/>
		+	4. Network layer to be moved to a separate library<br/>
		+
		+	<h4>Obstacles:</h4>
		+	0. <br/>
		+	a. Complicated connect/reconnect/pending logic<br/>
		+	b. server is multithreaded<br/>
		+	c. excessive use of low-level network API like send_buffer throughout the code.<br/>
		+	d. testing is complicated and involves different OSes<br/>
		+
		+	1. <br/>
		+	a. host name, port to be specified separately<br/>
		+	b. proxy authorization may be required<br/>
		+	c. proxy authorization method is not known in advance<br/>
		+	d. authorization credentials to be specified separately<br/>
		+	e. additional manipulations required on connect, disconnect, reconnects<br/>
		+	f. testing is complicated and involves configuring proxy servers<br/>
		+
		+	2.<br/>
		+	a. No idea about desired timeouts flexibility - should they differ for different operations, should they differ between connections?<br/>
		+	b. each socket operation to be wrapped in a call to asynchronous timer. timers used should be disarmed on successful completion - races are possible (in case if the operation finishes just before the timer deadline)<br/>
		+	c. are they really required? socket.cancel() functionality solves many problems. will it be of any help?<br/>
		+
		+	3.<br/>
		+	a. network.cpp employes poor programming techniques:<br/>
		+	i. static variables, variables defined in the scope of network.cpp and these are key variables like connections, sockets, etc.<br/>
		+	ii. network layer API is accessed throughout the code, especially low-level functions like send_data() and nconnections().<br/>
		+
		+	4.<br/>
		+	a. motivation is not clear (no other wesnoth-client-network libraries known)<br/>
		+	b. same as 3a<br/>
		+	c. windows has its own pitfalls regarding dynamic libraries<br/>
		+
		+	<h4> Solution:</h4>
		+	0. <br/>
		+	a. ask author about details which are not obvious<br/>
		+	b. don't change server logic except of fixing bugs and synchronization issues<br/>
		+	c. avoid changing logic<br/>
		+	d. use VirtualBox to run wesnoth on different OSes<br/>
		+
		+	1.<br/>
		+	a. modify settings window, use environment as a temprorary solution<br/>
		+	b. implement basic and digest authorization schemes. document solution for wrapping ntlm into basic/digest scheme<br/>
		+	c. <br/>
		+	i. implement simple http-proxy-server response parser to determine desired authorization scheme<br/>
		+	ii. ask user<br/>
		+	iii. try all<br/>
		+	d. use the same proxy settings window mentioned in 1a.<br/>
		+	e. employ virtual polymorphism - define an abstract ISocket, inherit DirectConnectionSocket and ProxySocket. ProxySocket overloads connect/disconnect methods to establish CONNECT to the game server. Using such sockets will add no coding overhead.<br/>
		+	f. configure Squid3 on localhost or another computer for the sake of testing. <br/>
		+
		+	2.<br/>
		+	a. continue asking developers about the idea<br/>
		+	b. study boost samples about the race problem<br/>
		+	c. continue asking developers about the timeouts idea<br/>
		+
		+	3. <br/>
		+	a. redesign existing network code introducing network object that will passed around together with such an omnipresent object as game_config<br/>
		+
		+	4<br/>
		+	a. continue asking developers about the idea<br/>
		+	b. Do encapsulation (3.) first, then adopt to be a library<br/>
		+	c. Remember troubles experienced during dlls development<br/>
		+
		+	<h4>The following code will be changed:</h4>
		+	0. <br/>
		+	* Code dealing with SDLNet library:<br/>
		+	- network.cpp<br/>
		+	- network_worker.cpp<br/>
		+	* Code invoking funtions of namespace network. e.g.:<br/>
		+	if (network::nconnections() > 0)<br/>
		+	network::disconnect();<br/>
		+	After network is encapsulated in an object, such an invokation won't be possible. It will have to be changed to something like game->get_network()->disconnect()<br/>
		+	- addon_management.cpp<br/>
		+	- dialogs.cpp<br/>
		+	- game_preferences.cpp<br/>
		+	- menu_events.cpp<br/>
		+	- multiplayer_connect.cpp<br/>
		+	- multiplayer.cpp<br/>
		+	- multiplayer_ui.cpp<br/>
		+	- playcampaign.cpp<br/>
		+	- play_controller.cpp<br/>
		+	- playmp_controller.cpp<br/>
		+	- playsingle_controller.cpp<br/>
		+	- playturn.cpp<br/>
		+	- random.cpp<br/>
		+	- replay.cpp<br/>
		+	- server/campaign_server.cpp<br/>
		+	- server/game.cpp<br/>
		+	- server/player_network.cpp<br/>
		+	- server/proxy.cpp<br/>
		+	- server/server.cpp<br/>
		+	- tests/test_network_worker.cpp<br/>
		+
		+	1. Modify preferences window:<br/>
		+	- game_preferences.hpp <br/>
		+	- game_preferences.cpp<br/>
		+	Use md5.cpp and sha1.cpp to implement digest proxy authorization<br/>
		+	Basic proxy authorization requires base64 algorithm, already implemented in http_file_uploader.cpp. Move the algorithm to a separate source file.<br/>
		+	Provide a verbose description of using ntlm-wrappers such as cntlm at wiki<br/>
		+	Define socket interface duplicating boost::asio::ip::tcp::socket interface in <br/>
		+	- abstract_socket.hpp<br/>
		+	Provide 2 socket implentations: <br/>
		+	- network/direct_connection_socket.Xpp<br/>
		+	- network/proxy_connection_socket.Xpp<br/>
		+	both socket implementations aggregates boost socket that performs the actual work.<br/>
		+	proxy_connection_socket will stand for dealing with proxies and all authorization schemas<br/>
		+	For the sake of ability to move network layer in a separate library, provide socket_factory interface and implementation:<br/>
		+	- abstract_socket_factory.hpp<br/>
		+	- network/socket_factory.Xpp<br/>
		+
		+	2. To be discussed<br/>
		+
		+	3. redesign network.cpp introducing a network class, containing all kinds of variables currently defined inside network.cpp.<br/>
		+	passing this object around will require a number of changes in classes <br/>
		+
		+	4. Major buildfiles changes to build a dynamic library (wesnoth_client_network.so/.dll) and link client against it<br/>

← Older revision		Revision as of 19:24, 8 April 2010
Line 1:		Line 1:
−	{{~~SoC2010Student~~}}	+	{{SoC2010Student_2\|orfest\|SoC Ideas Network Stack Rewrite}}
	[[Category:SoC Ideas Network Stack Rewrite]]		[[Category:SoC Ideas Network Stack Rewrite]]

@@ Line 137: / Line 137: @@
 <h4>4.4) Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4>
-Let's number all the summer weeks w1-w13
+Let's number all the summer weeks w1-w13<br/>
 w1 - installing VMs for different OSes, configuring authorizing proxies