Monday, September 10, 2007

How to get list of windows user in C#

If you want to have the list of an specific windows group in C# you can get this list by these lines of code below. Notice that you have to add a reference to System.DirectoryServices .

DirectoryEntry localMachine = new DirectoryEntry("WinNT://" + Environment.MachineName);
DirectoryEntry admGroup = localMachine.Children.Find("administrators","group");
object members = admGroup.Invoke("members", null);
foreach (object groupMember in (IEnumerable)members)
{
    DirectoryEntry member = new DirectoryEntry(groupMember);
    lstUsers.Items.Add(member.Name);
}

you can download the source code here:
http://www.tabatabaei.info/csharpsamples/WindowsGroupMember.rar

Saturday, September 8, 2007

Detecting is current user an Administrator

In some cases in your windows application you may want to know is the current user a member of Aministrators group or not?
To detect this you can get an object of WindowsIdentity like this:

WindowsIdentity identity = WindowsIdentity.GetCurrent();

Then create an instance of WindowsPrincipan by :

WindowsPrincipal principal = new WindowsPrincipal(identity);

and finally check it by using IsInRole() method like this:

string role = "BUILTIN\\Administrators";
bool IsAdmin = principal.IsInRole(role));

then you can use the IsAdmin variable to determine whether the current user is an Admin or not.

Wednesday, September 5, 2007

Remoting in C#

While you are developing distributed application by csharp, you might need to have communication between objects that run in different processes.
.NET remoting enables client applications to use objects in other processes on the same computer or on any other computer available on its network.(MSDN)

Each remoting application consist of three part:

  • A remotable object.

  • A host application domain to listen for requests for that object.

  • A client application domain that makes requests for that object.

We have two kind of remotable objects, one Marshal-by-value objects and Marshal-by-reference objects.
  • Marshal-by-value objects are either inherited from ISerializable interface or using a Serializable attribute, which are copied and passed from the application domain.
  • Marshal-by-reference objects are the objects from a class which is inherited from MarshalByRefObject class.
Notice that the objects from other classes which are not in that two types cannot be used in remoting.

Part 1: Remotable Types
In my first post about remoting I will create a class named "MyRemotableType" which is a Marshal-by-reference type, and I will put this class into a class library with name MyRemotableTypes.dll.

public class MyRemotableType:MarshalByRefObject
{
public MyRemotableType()
{
Console.WriteLine("A New MarshalByRefObject created");
}
public void AddNumbers(int a,int b)
{
Console.WriteLine("Sum is : {0}",a+b);
}

public string CaldSum(int a,int b)
{
return string.Format("Sum is: {0}", a + b);
}

}


Notice that Marshal-by-reference objects needs to be activated. Activation for Marshal-by-reference objects has two types:
  • Server activation: which means that objects will be created by server at the first method call, but not when the object is initializing by calling new keyword.
  • Client activation: which means that objects will be created by server when the client calls the new keyword.
Server activation it self contains two types, which can be specified with using WellKnownObjectMode enumeration items:
  • Singleton: It means that there will always be only one instance, regardless of how many clients there are for that object, and which have a default lifetime.
  • SingleCall: It means that the system creates a new object for each client method invocation.
Part 2: Host Application
Now I need another application which will listen to request from clients. In this sample I 'm going to create a console application. First I have to add a reference to System.RunTime.Remoting. Then I have to prepare a communication line between clients and server. To do this you can use a TCP or HTTP channel. Like this:

HttpChannel channel = new HttpChannel(1234);
ChannelServices.RegisterChannel(channel);

Then you have register the remotable types you want to prepare. As I said before you can choose with activation you want to use. If you want to have Server Activation use this line of code:

RemotingConfiguration.RegisterWellKnownServiceType(typeof(MyRemotableType),"RemotingTest.soap", WellKnownObjectMode.Singleton);
Console.WriteLine("Remote server started ...\r\nPress enter to stop");
Console.ReadLine();

Notice that in line above I used the Singleton but you can change it to SingleCall, also.You can also use RegisterActivatedServiceType . Notice that here in server application I used ReigsterXXXXServicesType
but in the client side you have to use RegisterXXXXClientType. And I also passed a name for this channel " RemotingTest.soap", this name is used to find the remote channel.

Part 3: Client Application
Now I want to use MyRemotableType and create instance from that but as a remote object. To do this first I add a reference to my MyRemotableTypes.dll. The I have to set the channel in my client application. I do this by using the RegisterWellKnownClientType method of RemotingConfiguration, as I said before.

RemotingConfiguration.RegisterWellKnownClientType(typeof(MyRemotableType),"http://RemoteServerName/RemotingTest.soap");

But notice that you give the type you want to use by remoting and also the url of remote server as parameters.
Now try to create some objects from the MyRemotableType.

MyRemotableType t = new MyRemotableType();
t.AddNumbers(10,10);
Console.WriteLine(t.CaldSum(10,10));

Part 4: Test the Applications
Now for testing the application, first run the Server Application,then while the server is running start the client application. And see the result.

As you may see, you will get just one line printed in client :

Sum is: 20


But in server side you got two printed line:
A New MarshalByRefObject created
ُS um is: 20

It means that you the object is created on server and the first method call is Writing to Console of server, but the result of method is accessible in client.

It will discuss more about remoting in my next posts.
You can download the sample code at:
http://www.tabatabaei.info/csharpsamples/firstremoting.rar

Tuesday, September 4, 2007

C# Copy Semantics

Let 's talk about Copy Semantics a little bit in C# Tuning
There is three type of object copy in C#.

  1. Reference copy
  2. Shallow copy
  3. Deep copy
As you may now the default behavior of c# compiler is the first one. Let me explain it by a sample:

Person p = new Person("Ali", 40);

Person p2 = p;
p2.Name = "Reza";
Console.WriteLine(p.Name); // ==>> the result is Reza
Console.WriteLine (p2.Name); // ==>> the result is Reza

By default when you have the code above you will get a reference copy of your p object. It means that, if you change the value of p2 it will effect the values of p.
So if I want a real copy of my object what I have to do?
There is two way to do this, but with a different. Imagine that I have a class named Invoice which has a reference to Person class, like this:

public class Invoice
{
public int No;
public DateTime Date;
public Person Customer;
//.............
}

Now I want to have a copy of my Invoice object inc.

Invoice inc = new Invoice("1001",DateTime.Now,new Person("Reza",40));

// Invoice inc2 = inc; // It 's not what I really want.

So I have to use the second type of object copy which is Shallow copy. In Shallow Copy you will get a new object with all the values copies to the new object. But the point is that you just have a reference copy of you related references types (like Customer: Person). To get a Shallow Copy of your object you can use MemberwiseClone() method of object. I've created a method called ShallowCopy() in my Invoice class.

public Invoice ShallowCopy()
{
return (Invoice)this.MemberwiseClone();
}

Then if you create an object copy of your invoice and change No or Date values this will not effect to the inc object values. But changing the value of it 's Customer, will do:

Invoice inc2 = inc.ShallowCopy();
inc2.No = 1002;
inc2.Customer.Name = "Masoud";
Console.WriteLine("Invoice No: {0}, Customer Name :{1}",inc.No,inc.Customer.Name); // ==>
I nvoice No: 1001, Customer Name : Masoud
Console.WriteLine("Invoice No: {0}, Customer Name :{1}",inc2.No,inc2.Customer.Name);// ==> Invoice No: 1002, Customer Name : Masoud

To get a Deep Copy of you object, you have to implement IClonable interface for Invoice and all of it 's related classes:

public class Invoice: IClonable
{
public int No;
public DateTime Date;
public Person Customer;
//.............

public object Clone()
{
Invoice myInvoice = (Invoice)this.MemberwiseClone();
myInvoice.Customer = (Person) this.Customer.Clone();
return myInvoice;
}
}

public class Person: IClonable
{
public string Name;
public int Age;

public object Clone()
{
return this.MemberwiseClone();
}
}

Now you have a real deep copy of you invoice object.

Invoice inc3 = (Invoice) inc.Clone();
inc3.No = 1003;
inc3.Customer.Name = "Mohammad";
Console.WriteLine("Invoice No: {0}, Customer Name :{1}",inc.No,inc.Customer.Name); // ==>
I nvoice No: 1001, Customer Name : Masoud
Console.WriteLine("Invoice No: {0}, Customer Name :{1}",inc2.No,inc2.Customer.Name);// ==> Invoice No: 1002, Customer Name : Masoud
Console.WriteLine("Invoice No: {0}, Customer Name :{1}",inc3.No,inc3.Customer.Name);// ==> Invoice No: 1003, Customer Name : Mohammad

You can download the sample code at:
http://www.tabatabaei.info/csharpsamples/copysemantics.rar